io.cloudshiftdev.awscdk.services.cloudwatch.CommonMetricOptions.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.cloudwatch
import io.cloudshiftdev.awscdk.Duration
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import kotlin.String
import kotlin.collections.Map
/**
* Options shared by most methods accepting metric options.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.*;
* import io.cloudshiftdev.awscdk.services.cloudwatch.*;
* CommonMetricOptions commonMetricOptions = CommonMetricOptions.builder()
* .account("account")
* .color("color")
* .dimensionsMap(Map.of(
* "dimensionsMapKey", "dimensionsMap"))
* .label("label")
* .period(Duration.minutes(30))
* .region("region")
* .statistic("statistic")
* .unit(Unit.SECONDS)
* .build();
* ```
*/
public interface CommonMetricOptions {
/**
* Account which this metric comes from.
*
* Default: - Deployment account.
*/
public fun account(): String? = unwrap(this).getAccount()
/**
* The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on
* a graph. The `Color` class has a set of standard colors that can be used here.
*
* Default: - Automatic color
*/
public fun color(): String? = unwrap(this).getColor()
/**
* Dimensions of the metric.
*
* Default: - No dimensions.
*/
public fun dimensionsMap(): Map = unwrap(this).getDimensionsMap() ?: emptyMap()
/**
* Label for this metric when added to a Graph in a Dashboard.
*
* You can use [dynamic
* labels](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html)
* to show summary information about the entire displayed time series
* in the legend. For example, if you use:
*
* ```
* [max: ${MAX}] MyMetric
* ```
*
* As the metric label, the maximum value in the visible range will
* be shown next to the time series name in the graph's legend.
*
* Default: - No label
*/
public fun label(): String? = unwrap(this).getLabel()
/**
* The period over which the specified statistic is applied.
*
* Default: Duration.minutes(5)
*/
public fun period(): Duration? = unwrap(this).getPeriod()?.let(Duration::wrap)
/**
* Region which this metric comes from.
*
* Default: - Deployment region.
*/
public fun region(): String? = unwrap(this).getRegion()
/**
* What function to use for aggregating.
*
* Use the `aws_cloudwatch.Stats` helper class to construct valid input strings.
*
* Can be one of the following:
*
* * "Minimum" | "min"
* * "Maximum" | "max"
* * "Average" | "avg"
* * "Sum" | "sum"
* * "SampleCount | "n"
* * "pNN.NN"
* * "tmNN.NN" | "tm(NN.NN%:NN.NN%)"
* * "iqm"
* * "wmNN.NN" | "wm(NN.NN%:NN.NN%)"
* * "tcNN.NN" | "tc(NN.NN%:NN.NN%)"
* * "tsNN.NN" | "ts(NN.NN%:NN.NN%)"
*
* Default: Average
*/
public fun statistic(): String? = unwrap(this).getStatistic()
/**
* Unit used to filter the metric stream.
*
* Only refer to datums emitted to the metric stream with the given unit and
* ignore all others. Only useful when datums are being emitted to the same
* metric stream under different units.
*
* The default is to use all matric datums in the stream, regardless of unit,
* which is recommended in nearly all cases.
*
* CloudWatch does not honor this property for graphs.
*
* Default: - All metric datums in the given metric stream
*/
public fun unit(): Unit? = unwrap(this).getUnit()?.let(Unit::wrap)
/**
* A builder for [CommonMetricOptions]
*/
@CdkDslMarker
public interface Builder {
/**
* @param account Account which this metric comes from.
*/
public fun account(account: String)
/**
* @param color The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric
* is rendered on a graph. The `Color` class has a set of standard colors that can be used here.
*/
public fun color(color: String)
/**
* @param dimensionsMap Dimensions of the metric.
*/
public fun dimensionsMap(dimensionsMap: Map)
/**
* @param label Label for this metric when added to a Graph in a Dashboard.
* You can use [dynamic
* labels](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html)
* to show summary information about the entire displayed time series
* in the legend. For example, if you use:
*
* ```
* [max: ${MAX}] MyMetric
* ```
*
* As the metric label, the maximum value in the visible range will
* be shown next to the time series name in the graph's legend.
*/
public fun label(label: String)
/**
* @param period The period over which the specified statistic is applied.
*/
public fun period(period: Duration)
/**
* @param region Region which this metric comes from.
*/
public fun region(region: String)
/**
* @param statistic What function to use for aggregating.
* Use the `aws_cloudwatch.Stats` helper class to construct valid input strings.
*
* Can be one of the following:
*
* * "Minimum" | "min"
* * "Maximum" | "max"
* * "Average" | "avg"
* * "Sum" | "sum"
* * "SampleCount | "n"
* * "pNN.NN"
* * "tmNN.NN" | "tm(NN.NN%:NN.NN%)"
* * "iqm"
* * "wmNN.NN" | "wm(NN.NN%:NN.NN%)"
* * "tcNN.NN" | "tc(NN.NN%:NN.NN%)"
* * "tsNN.NN" | "ts(NN.NN%:NN.NN%)"
*/
public fun statistic(statistic: String)
/**
* @param unit Unit used to filter the metric stream.
* Only refer to datums emitted to the metric stream with the given unit and
* ignore all others. Only useful when datums are being emitted to the same
* metric stream under different units.
*
* The default is to use all matric datums in the stream, regardless of unit,
* which is recommended in nearly all cases.
*
* CloudWatch does not honor this property for graphs.
*/
public fun unit(unit: Unit)
}
private class BuilderImpl : Builder {
private val cdkBuilder: software.amazon.awscdk.services.cloudwatch.CommonMetricOptions.Builder =
software.amazon.awscdk.services.cloudwatch.CommonMetricOptions.builder()
/**
* @param account Account which this metric comes from.
*/
override fun account(account: String) {
cdkBuilder.account(account)
}
/**
* @param color The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric
* is rendered on a graph. The `Color` class has a set of standard colors that can be used here.
*/
override fun color(color: String) {
cdkBuilder.color(color)
}
/**
* @param dimensionsMap Dimensions of the metric.
*/
override fun dimensionsMap(dimensionsMap: Map) {
cdkBuilder.dimensionsMap(dimensionsMap)
}
/**
* @param label Label for this metric when added to a Graph in a Dashboard.
* You can use [dynamic
* labels](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html)
* to show summary information about the entire displayed time series
* in the legend. For example, if you use:
*
* ```
* [max: ${MAX}] MyMetric
* ```
*
* As the metric label, the maximum value in the visible range will
* be shown next to the time series name in the graph's legend.
*/
override fun label(label: String) {
cdkBuilder.label(label)
}
/**
* @param period The period over which the specified statistic is applied.
*/
override fun period(period: Duration) {
cdkBuilder.period(period.let(Duration.Companion::unwrap))
}
/**
* @param region Region which this metric comes from.
*/
override fun region(region: String) {
cdkBuilder.region(region)
}
/**
* @param statistic What function to use for aggregating.
* Use the `aws_cloudwatch.Stats` helper class to construct valid input strings.
*
* Can be one of the following:
*
* * "Minimum" | "min"
* * "Maximum" | "max"
* * "Average" | "avg"
* * "Sum" | "sum"
* * "SampleCount | "n"
* * "pNN.NN"
* * "tmNN.NN" | "tm(NN.NN%:NN.NN%)"
* * "iqm"
* * "wmNN.NN" | "wm(NN.NN%:NN.NN%)"
* * "tcNN.NN" | "tc(NN.NN%:NN.NN%)"
* * "tsNN.NN" | "ts(NN.NN%:NN.NN%)"
*/
override fun statistic(statistic: String) {
cdkBuilder.statistic(statistic)
}
/**
* @param unit Unit used to filter the metric stream.
* Only refer to datums emitted to the metric stream with the given unit and
* ignore all others. Only useful when datums are being emitted to the same
* metric stream under different units.
*
* The default is to use all matric datums in the stream, regardless of unit,
* which is recommended in nearly all cases.
*
* CloudWatch does not honor this property for graphs.
*/
override fun unit(unit: Unit) {
cdkBuilder.unit(unit.let(Unit.Companion::unwrap))
}
public fun build(): software.amazon.awscdk.services.cloudwatch.CommonMetricOptions =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.cloudwatch.CommonMetricOptions,
) : CdkObject(cdkObject),
CommonMetricOptions {
/**
* Account which this metric comes from.
*
* Default: - Deployment account.
*/
override fun account(): String? = unwrap(this).getAccount()
/**
* The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered
* on a graph. The `Color` class has a set of standard colors that can be used here.
*
* Default: - Automatic color
*/
override fun color(): String? = unwrap(this).getColor()
/**
* Dimensions of the metric.
*
* Default: - No dimensions.
*/
override fun dimensionsMap(): Map = unwrap(this).getDimensionsMap() ?:
emptyMap()
/**
* Label for this metric when added to a Graph in a Dashboard.
*
* You can use [dynamic
* labels](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html)
* to show summary information about the entire displayed time series
* in the legend. For example, if you use:
*
* ```
* [max: ${MAX}] MyMetric
* ```
*
* As the metric label, the maximum value in the visible range will
* be shown next to the time series name in the graph's legend.
*
* Default: - No label
*/
override fun label(): String? = unwrap(this).getLabel()
/**
* The period over which the specified statistic is applied.
*
* Default: Duration.minutes(5)
*/
override fun period(): Duration? = unwrap(this).getPeriod()?.let(Duration::wrap)
/**
* Region which this metric comes from.
*
* Default: - Deployment region.
*/
override fun region(): String? = unwrap(this).getRegion()
/**
* What function to use for aggregating.
*
* Use the `aws_cloudwatch.Stats` helper class to construct valid input strings.
*
* Can be one of the following:
*
* * "Minimum" | "min"
* * "Maximum" | "max"
* * "Average" | "avg"
* * "Sum" | "sum"
* * "SampleCount | "n"
* * "pNN.NN"
* * "tmNN.NN" | "tm(NN.NN%:NN.NN%)"
* * "iqm"
* * "wmNN.NN" | "wm(NN.NN%:NN.NN%)"
* * "tcNN.NN" | "tc(NN.NN%:NN.NN%)"
* * "tsNN.NN" | "ts(NN.NN%:NN.NN%)"
*
* Default: Average
*/
override fun statistic(): String? = unwrap(this).getStatistic()
/**
* Unit used to filter the metric stream.
*
* Only refer to datums emitted to the metric stream with the given unit and
* ignore all others. Only useful when datums are being emitted to the same
* metric stream under different units.
*
* The default is to use all matric datums in the stream, regardless of unit,
* which is recommended in nearly all cases.
*
* CloudWatch does not honor this property for graphs.
*
* Default: - All metric datums in the given metric stream
*/
override fun unit(): Unit? = unwrap(this).getUnit()?.let(Unit::wrap)
}
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit = {}): CommonMetricOptions {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.cloudwatch.CommonMetricOptions):
CommonMetricOptions = CdkObjectWrappers.wrap(cdkObject) as? CommonMetricOptions ?:
Wrapper(cdkObject)
internal fun unwrap(wrapped: CommonMetricOptions):
software.amazon.awscdk.services.cloudwatch.CommonMetricOptions = (wrapped as
CdkObject).cdkObject as software.amazon.awscdk.services.cloudwatch.CommonMetricOptions
}
}