Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.cloudwatch.kotlin
import com.pulumi.awsnative.cloudwatch.kotlin.outputs.AlarmDimension
import com.pulumi.awsnative.cloudwatch.kotlin.outputs.AlarmMetricDataQuery
import com.pulumi.awsnative.kotlin.outputs.Tag
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Double
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import com.pulumi.awsnative.cloudwatch.kotlin.outputs.AlarmDimension.Companion.toKotlin as alarmDimensionToKotlin
import com.pulumi.awsnative.cloudwatch.kotlin.outputs.AlarmMetricDataQuery.Companion.toKotlin as alarmMetricDataQueryToKotlin
import com.pulumi.awsnative.kotlin.outputs.Tag.Companion.toKotlin as tagToKotlin
/**
* Builder for [Alarm].
*/
@PulumiTagMarker
public class AlarmResourceBuilder internal constructor() {
public var name: String? = null
public var args: AlarmArgs = AlarmArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend AlarmArgsBuilder.() -> Unit) {
val builder = AlarmArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): Alarm {
val builtJavaResource = com.pulumi.awsnative.cloudwatch.Alarm(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Alarm(builtJavaResource)
}
}
/**
* The ``AWS::CloudWatch::Alarm`` type specifies an alarm and associates it with the specified metric or metric math expression.
* When this operation creates an alarm, the alarm state is immediately set to ``INSUFFICIENT_DATA``. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.
* When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
*/
public class Alarm internal constructor(
override val javaResource: com.pulumi.awsnative.cloudwatch.Alarm,
) : KotlinCustomResource(javaResource, AlarmMapper) {
/**
* Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
*/
public val actionsEnabled: Output?
get() = javaResource.actionsEnabled().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*.
*/
public val alarmActions: Output>?
get() = javaResource.alarmActions().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
/**
* The description of the alarm.
*/
public val alarmDescription: Output?
get() = javaResource.alarmDescription().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name.
* If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
*/
public val alarmName: Output?
get() = javaResource.alarmName().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The ARN of the CloudWatch alarm, such as `arn:aws:cloudwatch:us-west-2:123456789012:alarm:myCloudWatchAlarm-CPUAlarm-UXMMZK36R55Z` .
*/
public val arn: Output
get() = javaResource.arn().applyValue({ args0 -> args0 })
/**
* The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
*/
public val comparisonOperator: Output
get() = javaResource.comparisonOperator().applyValue({ args0 -> args0 })
/**
* The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for ``EvaluationPeriods`` is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
* If you omit this parameter, CW uses the same value here that you set for ``EvaluationPeriods``, and the alarm goes to alarm state if that many consecutive periods are breaching.
*/
public val datapointsToAlarm: Output?
get() = javaResource.datapointsToAlarm().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify ``Dimensions``. Instead, you use ``Metrics``.
*/
public val dimensions: Output>?
get() = javaResource.dimensions().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> alarmDimensionToKotlin(args0) })
})
}).orElse(null)
})
/**
* Used only for alarms based on percentiles. If ``ignore``, the alarm state does not change during periods with too few data points to be statistically significant. If ``evaluate`` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
*/
public val evaluateLowSampleCountPercentile: Output?
get() = javaResource.evaluateLowSampleCountPercentile().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and ``DatapointsToAlarm`` is the M.
* For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
*/
public val evaluationPeriods: Output
get() = javaResource.evaluationPeriods().applyValue({ args0 -> args0 })
/**
* The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
* For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.
* For an alarm based on a math expression, you can't specify ``ExtendedStatistic``. Instead, you use ``Metrics``.
*/
public val extendedStatistic: Output?
get() = javaResource.extendedStatistic().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The actions to execute when this alarm transitions to the ``INSUFFICIENT_DATA`` state from any other state. Each action is specified as an Amazon Resource Name (ARN).
*/
public val insufficientDataActions: Output>?
get() = javaResource.insufficientDataActions().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0 })
}).orElse(null)
})
/**
* The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use ``Metrics`` instead and you can't specify ``MetricName``.
*/
public val metricName: Output?
get() = javaResource.metricName().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.
* If you specify the ``Metrics`` parameter, you cannot specify ``MetricName``, ``Dimensions``, ``Period``, ``Namespace``, ``Statistic``, ``ExtendedStatistic``, or ``Unit``.
*/
public val metrics: Output>?
get() = javaResource.metrics().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> alarmMetricDataQueryToKotlin(args0) })
})
}).orElse(null)
})
/**
* The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify ``Namespace`` and you use ``Metrics`` instead.
* For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
*/
public val namespace: Output?
get() = javaResource.namespace().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The actions to execute when this alarm transitions to the ``OK`` state from any other state. Each action is specified as an Amazon Resource Name (ARN).
*/
public val okActions: Output>?
get() = javaResource.okActions().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
/**
* The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.
* For an alarm based on a math expression, you can't specify ``Period``, and instead you use the ``Metrics`` parameter.
* *Minimum:* 10
*/
public val period: Output?
get() = javaResource.period().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ``ExtendedStatistic``.
* For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.
* For an alarm based on a math expression, you can't specify ``Statistic``. Instead, you use ``Metrics``.
*/
public val statistic: Output?
get() = javaResource.statistic().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the ``cloudwatch:TagResource`` permission.
* Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
*/
public val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> tagToKotlin(args0) })
})
}).orElse(null)
})
/**
* The value to compare with the specified statistic.
*/
public val threshold: Output?
get() = javaResource.threshold().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* In an alarm based on an anomaly detection model, this is the ID of the ``ANOMALY_DETECTION_BAND`` function used as the threshold for the alarm.
*/
public val thresholdMetricId: Output?
get() = javaResource.thresholdMetricId().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Sets how this alarm is to handle missing data points. Valid values are ``breaching``, ``notBreaching``, ``ignore``, and ``missing``. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*.
* If you omit this parameter, the default behavior of ``missing`` is used.
*/
public val treatMissingData: Output?
get() = javaResource.treatMissingData().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a ``Metrics`` array.
* You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
*/
public val unit: Output?
get() = javaResource.unit().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
}
public object AlarmMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.awsnative.cloudwatch.Alarm::class == javaResource::class
override fun map(javaResource: Resource): Alarm = Alarm(
javaResource as
com.pulumi.awsnative.cloudwatch.Alarm,
)
}
/**
* @see [Alarm].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Alarm].
*/
public suspend fun alarm(name: String, block: suspend AlarmResourceBuilder.() -> Unit): Alarm {
val builder = AlarmResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Alarm].
* @param name The _unique_ name of the resulting resource.
*/
public fun alarm(name: String): Alarm {
val builder = AlarmResourceBuilder()
builder.name(name)
return builder.build()
}
