Package software.amazon.awscdk.cfnpropertymixins.services.medialive

Class CfnCloudWatchAlarmTemplatePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.medialive.CfnCloudWatchAlarmTemplatePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCloudWatchAlarmTemplatePropsMixin>

Enclosing class:

CfnCloudWatchAlarmTemplatePropsMixin

@Stability(Stable)
public static final class CfnCloudWatchAlarmTemplatePropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCloudWatchAlarmTemplatePropsMixin>

A fluent builder for CfnCloudWatchAlarmTemplatePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnCloudWatchAlarmTemplatePropsMixin	build()
CfnCloudWatchAlarmTemplatePropsMixin.Builder	comparisonOperator(String comparisonOperator)	The comparison operator used to compare the specified statistic and the threshold.
static CfnCloudWatchAlarmTemplatePropsMixin.Builder	create()
static CfnCloudWatchAlarmTemplatePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnCloudWatchAlarmTemplatePropsMixin.Builder	datapointsToAlarm(Number datapointsToAlarm)	The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
CfnCloudWatchAlarmTemplatePropsMixin.Builder	description(String description)	A resource's optional description.
CfnCloudWatchAlarmTemplatePropsMixin.Builder	evaluationPeriods(Number evaluationPeriods)	The number of periods over which data is compared to the specified threshold.
CfnCloudWatchAlarmTemplatePropsMixin.Builder	groupIdentifier(String groupIdentifier)	A cloudwatch alarm template group's identifier.
CfnCloudWatchAlarmTemplatePropsMixin.Builder	metricName(String metricName)	The name of the metric associated with the alarm.
CfnCloudWatchAlarmTemplatePropsMixin.Builder	name(String name)	A resource's name.
CfnCloudWatchAlarmTemplatePropsMixin.Builder	period(Number period)	The period, in seconds, over which the specified statistic is applied.
CfnCloudWatchAlarmTemplatePropsMixin.Builder	statistic(String statistic)	The statistic to apply to the alarm's metric data.
CfnCloudWatchAlarmTemplatePropsMixin.Builder	tags(Map<String,String> tags)	Represents the tags associated with a resource.
CfnCloudWatchAlarmTemplatePropsMixin.Builder	targetResourceType(String targetResourceType)	The resource type this template should dynamically generate CloudWatch metric alarms for.
CfnCloudWatchAlarmTemplatePropsMixin.Builder	threshold(Number threshold)	The threshold value to compare with the specified statistic.
CfnCloudWatchAlarmTemplatePropsMixin.Builder	treatMissingData(String treatMissingData)	Specifies how missing data points are treated when evaluating the alarm's condition.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnCloudWatchAlarmTemplatePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnCloudWatchAlarmTemplatePropsMixin.Builder.

create

@Stability(Stable)
public static CfnCloudWatchAlarmTemplatePropsMixin.Builder create()

Returns:

a new instance of CfnCloudWatchAlarmTemplatePropsMixin.Builder.

comparisonOperator

@Stability(Stable)
public CfnCloudWatchAlarmTemplatePropsMixin.Builder comparisonOperator(String comparisonOperator)

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

Parameters:

comparisonOperator - The comparison operator used to compare the specified statistic and the threshold. This parameter is required.

Returns:

this

See Also:

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

datapointsToAlarm

@Stability(Stable)
public CfnCloudWatchAlarmTemplatePropsMixin.Builder datapointsToAlarm(Number datapointsToAlarm)

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

Default: - 0

Parameters:

datapointsToAlarm - The number of datapoints within the evaluation period that must be breaching to trigger the alarm. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnCloudWatchAlarmTemplatePropsMixin.Builder description(String description)

A resource's optional description.

Parameters:

description - A resource's optional description. This parameter is required.

Returns:

this

See Also:

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

evaluationPeriods

@Stability(Stable)
public CfnCloudWatchAlarmTemplatePropsMixin.Builder evaluationPeriods(Number evaluationPeriods)

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

Default: - 0

Parameters:

evaluationPeriods - The number of periods over which data is compared to the specified threshold. This parameter is required.

Returns:

this

See Also:

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

groupIdentifier

@Stability(Stable)
public CfnCloudWatchAlarmTemplatePropsMixin.Builder groupIdentifier(String groupIdentifier)

A cloudwatch alarm template group's identifier.

Can be either be its id or current name.

Parameters:

groupIdentifier - A cloudwatch alarm template group's identifier. This parameter is required.

Returns:

this

See Also:

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

metricName

@Stability(Stable)
public CfnCloudWatchAlarmTemplatePropsMixin.Builder metricName(String metricName)

The name of the metric associated with the alarm.

Must be compatible with targetResourceType.

Parameters:

metricName - The name of the metric associated with the alarm. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnCloudWatchAlarmTemplatePropsMixin.Builder name(String name)

A resource's name.

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

Parameters:

name - A resource's name. This parameter is required.

Returns:

this

See Also:

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

period

@Stability(Stable)
public CfnCloudWatchAlarmTemplatePropsMixin.Builder period(Number period)

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

Default: - 0

Parameters:

period - The period, in seconds, over which the specified statistic is applied. This parameter is required.

Returns:

this

See Also:

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

statistic

@Stability(Stable)
public CfnCloudWatchAlarmTemplatePropsMixin.Builder statistic(String statistic)

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

Parameters:

statistic - The statistic to apply to the alarm's metric data. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnCloudWatchAlarmTemplatePropsMixin.Builder tags(Map<String,String> tags)

Represents the tags associated with a resource.

Parameters:

tags - Represents the tags associated with a resource. This parameter is required.

Returns:

this

See Also:

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

targetResourceType

@Stability(Stable)
public CfnCloudWatchAlarmTemplatePropsMixin.Builder targetResourceType(String targetResourceType)

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

Parameters:

targetResourceType - The resource type this template should dynamically generate CloudWatch metric alarms for. This parameter is required.

Returns:

this

See Also:

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

threshold

@Stability(Stable)
public CfnCloudWatchAlarmTemplatePropsMixin.Builder threshold(Number threshold)

The threshold value to compare with the specified statistic.

Default: - 0

Parameters:

threshold - The threshold value to compare with the specified statistic. This parameter is required.

Returns:

this

See Also:

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

treatMissingData

@Stability(Stable)
public CfnCloudWatchAlarmTemplatePropsMixin.Builder treatMissingData(String treatMissingData)

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

Parameters:

treatMissingData - Specifies how missing data points are treated when evaluating the alarm's condition. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnCloudWatchAlarmTemplatePropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnCloudWatchAlarmTemplatePropsMixin>

Returns:

a newly built instance of CfnCloudWatchAlarmTemplatePropsMixin.