Package software.amazon.awscdk.mixins.preview.services.medialive.mixins

Interface CfnCloudWatchAlarmTemplateMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCloudWatchAlarmTemplateMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:28.348Z")
@Stability(Stable)
public interface CfnCloudWatchAlarmTemplateMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnCloudWatchAlarmTemplatePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.mixins.preview.services.medialive.mixins.*;
 CfnCloudWatchAlarmTemplateMixinProps cfnCloudWatchAlarmTemplateMixinProps = CfnCloudWatchAlarmTemplateMixinProps.builder()
         .comparisonOperator("comparisonOperator")
         .datapointsToAlarm(123)
         .description("description")
         .evaluationPeriods(123)
         .groupIdentifier("groupIdentifier")
         .metricName("metricName")
         .name("name")
         .period(123)
         .statistic("statistic")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .targetResourceType("targetResourceType")
         .threshold(123)
         .treatMissingData("treatMissingData")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCloudWatchAlarmTemplateMixinProps.Builder	A builder for CfnCloudWatchAlarmTemplateMixinProps
static final class	CfnCloudWatchAlarmTemplateMixinProps.Jsii$Proxy	An implementation for CfnCloudWatchAlarmTemplateMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnCloudWatchAlarmTemplateMixinProps.Builder	builder()
default String	getComparisonOperator()	The comparison operator used to compare the specified statistic and the threshold.
default Number	getDatapointsToAlarm()	The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
default String	getDescription()	A resource's optional description.
default Number	getEvaluationPeriods()	The number of periods over which data is compared to the specified threshold.
default String	getGroupIdentifier()	A cloudwatch alarm template group's identifier.
default String	getMetricName()	The name of the metric associated with the alarm.
default String	getName()	A resource's name.
default Number	getPeriod()	The period, in seconds, over which the specified statistic is applied.
default String	getStatistic()	The statistic to apply to the alarm's metric data.
default Map<String,String>	getTags()	Represents the tags associated with a resource.
default String	getTargetResourceType()	The resource type this template should dynamically generate CloudWatch metric alarms for.
default Number	getThreshold()	The threshold value to compare with the specified statistic.
default String	getTreatMissingData()	Specifies how missing data points are treated when evaluating the alarm's condition.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComparisonOperator

@Stability(Stable)
@Nullable
default String getComparisonOperator()

The comparison operator used to compare the specified statistic and the threshold.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-comparisonoperator

getDatapointsToAlarm

@Stability(Stable)
@Nullable
default Number getDatapointsToAlarm()

The number of datapoints within the evaluation period that must be breaching to trigger the alarm.

Default: - 0

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-datapointstoalarm

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A resource's optional description.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-description

getEvaluationPeriods

@Stability(Stable)
@Nullable
default Number getEvaluationPeriods()

The number of periods over which data is compared to the specified threshold.

Default: - 0

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-evaluationperiods

getGroupIdentifier

@Stability(Stable)
@Nullable
default String getGroupIdentifier()

A cloudwatch alarm template group's identifier.

Can be either be its id or current name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-groupidentifier

getMetricName

@Stability(Stable)
@Nullable
default String getMetricName()

The name of the metric associated with the alarm.

Must be compatible with targetResourceType.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-metricname

getName

@Stability(Stable)
@Nullable
default String getName()

A resource's name.

Names must be unique within the scope of a resource type in a specific region.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-name

getPeriod

@Stability(Stable)
@Nullable
default Number getPeriod()

The period, in seconds, over which the specified statistic is applied.

Default: - 0

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-period

getStatistic

@Stability(Stable)
@Nullable
default String getStatistic()

The statistic to apply to the alarm's metric data.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-statistic

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

Represents the tags associated with a resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-tags

getTargetResourceType

@Stability(Stable)
@Nullable
default String getTargetResourceType()

The resource type this template should dynamically generate CloudWatch metric alarms for.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-targetresourcetype

getThreshold

@Stability(Stable)
@Nullable
default Number getThreshold()

The threshold value to compare with the specified statistic.

Default: - 0

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-threshold

getTreatMissingData

@Stability(Stable)
@Nullable
default String getTreatMissingData()

Specifies how missing data points are treated when evaluating the alarm's condition.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-cloudwatchalarmtemplate.html#cfn-medialive-cloudwatchalarmtemplate-treatmissingdata

builder

@Stability(Stable)
static CfnCloudWatchAlarmTemplateMixinProps.Builder builder()

Returns:

a CfnCloudWatchAlarmTemplateMixinProps.Builder of CfnCloudWatchAlarmTemplateMixinProps