Package software.amazon.awscdk.services.iotevents

Class CfnAlarmModel.Builder

java.lang.Object

software.amazon.awscdk.services.iotevents.CfnAlarmModel.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAlarmModel>

Enclosing class:

CfnAlarmModel

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

A fluent builder for CfnAlarmModel.

Method Summary

Modifier and Type	Method	Description
CfnAlarmModel.Builder	alarmCapabilities(IResolvable alarmCapabilities)	Contains the configuration information of alarm state changes.
CfnAlarmModel.Builder	alarmCapabilities(CfnAlarmModel.AlarmCapabilitiesProperty alarmCapabilities)	Contains the configuration information of alarm state changes.
CfnAlarmModel.Builder	alarmEventActions(IResolvable alarmEventActions)	Contains information about one or more alarm actions.
CfnAlarmModel.Builder	alarmEventActions(CfnAlarmModel.AlarmEventActionsProperty alarmEventActions)	Contains information about one or more alarm actions.
CfnAlarmModel.Builder	alarmModelDescription(String alarmModelDescription)	The description of the alarm model.
CfnAlarmModel.Builder	alarmModelName(String alarmModelName)	The name of the alarm model.
CfnAlarmModel.Builder	alarmRule(IResolvable alarmRule)	Defines when your alarm is invoked.
CfnAlarmModel.Builder	alarmRule(CfnAlarmModel.AlarmRuleProperty alarmRule)	Defines when your alarm is invoked.
CfnAlarmModel	build()
static CfnAlarmModel.Builder	create(software.constructs.Construct scope, String id)
CfnAlarmModel.Builder	key(String key)	An input attribute used as a key to create an alarm.
CfnAlarmModel.Builder	roleArn(String roleArn)	The ARN of the IAM role that allows the alarm to perform actions and access AWS resources.
CfnAlarmModel.Builder	severity(Number severity)	A non-negative integer that reflects the severity level of the alarm.
CfnAlarmModel.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs that contain metadata for the alarm model.

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 CfnAlarmModel.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnAlarmModel.Builder.

alarmRule

@Stability(Stable)
public CfnAlarmModel.Builder alarmRule(IResolvable alarmRule)

Defines when your alarm is invoked.

Parameters:

alarmRule - Defines when your alarm is invoked. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-alarmrule

alarmRule

@Stability(Stable)
public CfnAlarmModel.Builder alarmRule(CfnAlarmModel.AlarmRuleProperty alarmRule)

Defines when your alarm is invoked.

Parameters:

alarmRule - Defines when your alarm is invoked. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-alarmrule

roleArn

@Stability(Stable)
public CfnAlarmModel.Builder roleArn(String roleArn)

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources.

For more information, see Amazon Resource Names (ARNs) in the AWS General Reference .

Parameters:

roleArn - The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-rolearn

alarmCapabilities

@Stability(Stable)
public CfnAlarmModel.Builder alarmCapabilities(IResolvable alarmCapabilities)

Contains the configuration information of alarm state changes.

Parameters:

alarmCapabilities - Contains the configuration information of alarm state changes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-alarmcapabilities

alarmCapabilities

@Stability(Stable)
public CfnAlarmModel.Builder alarmCapabilities(CfnAlarmModel.AlarmCapabilitiesProperty alarmCapabilities)

Contains the configuration information of alarm state changes.

Parameters:

alarmCapabilities - Contains the configuration information of alarm state changes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-alarmcapabilities

alarmEventActions

@Stability(Stable)
public CfnAlarmModel.Builder alarmEventActions(IResolvable alarmEventActions)

Contains information about one or more alarm actions.

Parameters:

alarmEventActions - Contains information about one or more alarm actions. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-alarmeventactions

alarmEventActions

@Stability(Stable)
public CfnAlarmModel.Builder alarmEventActions(CfnAlarmModel.AlarmEventActionsProperty alarmEventActions)

Contains information about one or more alarm actions.

Parameters:

alarmEventActions - Contains information about one or more alarm actions. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-alarmeventactions

alarmModelDescription

@Stability(Stable)
public CfnAlarmModel.Builder alarmModelDescription(String alarmModelDescription)

The description of the alarm model.

Parameters:

alarmModelDescription - The description of the alarm model. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-alarmmodeldescription

alarmModelName

@Stability(Stable)
public CfnAlarmModel.Builder alarmModelName(String alarmModelName)

The name of the alarm model.

Parameters:

alarmModelName - The name of the alarm model. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-alarmmodelname

key

@Stability(Stable)
public CfnAlarmModel.Builder key(String key)

An input attribute used as a key to create an alarm.

AWS IoT Events routes inputs associated with this key to the alarm.

Parameters:

key - An input attribute used as a key to create an alarm. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-key

severity

@Stability(Stable)
public CfnAlarmModel.Builder severity(Number severity)

A non-negative integer that reflects the severity level of the alarm.

Parameters:

severity - A non-negative integer that reflects the severity level of the alarm. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-severity

tags

@Stability(Stable)
public CfnAlarmModel.Builder tags(List<? extends CfnTag> tags)

A list of key-value pairs that contain metadata for the alarm model.

The tags help you manage the alarm model. For more information, see Tagging your AWS IoT Events resources in the AWS IoT Events Developer Guide .

You can create up to 50 tags for one alarm model.

Parameters:

tags - A list of key-value pairs that contain metadata for the alarm model. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnAlarmModel build()

Specified by:

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

Returns:

a newly built instance of CfnAlarmModel.