Package software.amazon.awscdk.services.iotevents

Class CfnAlarmModel

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iotevents.CfnAlarmModel

All Implemented Interfaces:

IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-02T15:58:28.011Z")
@Stability(Stable)
public class CfnAlarmModel
extends CfnResource
implements IInspectable, ITaggable

Represents an alarm model to monitor an AWS IoT Events input attribute.

You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the AWS IoT Events Developer Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotevents.*;
 CfnAlarmModel cfnAlarmModel = CfnAlarmModel.Builder.create(this, "MyCfnAlarmModel")
         .alarmRule(AlarmRuleProperty.builder()
                 .simpleRule(SimpleRuleProperty.builder()
                         .comparisonOperator("comparisonOperator")
                         .inputProperty("inputProperty")
                         .threshold("threshold")
                         .build())
                 .build())
         .roleArn("roleArn")
         // the properties below are optional
         .alarmCapabilities(AlarmCapabilitiesProperty.builder()
                 .acknowledgeFlow(AcknowledgeFlowProperty.builder()
                         .enabled(false)
                         .build())
                 .initializationConfiguration(InitializationConfigurationProperty.builder()
                         .disabledOnInitialization(false)
                         .build())
                 .build())
         .alarmEventActions(AlarmEventActionsProperty.builder()
                 .alarmActions(List.of(AlarmActionProperty.builder()
                         .dynamoDb(DynamoDBProperty.builder()
                                 .hashKeyField("hashKeyField")
                                 .hashKeyValue("hashKeyValue")
                                 .tableName("tableName")
                                 // the properties below are optional
                                 .hashKeyType("hashKeyType")
                                 .operation("operation")
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .payloadField("payloadField")
                                 .rangeKeyField("rangeKeyField")
                                 .rangeKeyType("rangeKeyType")
                                 .rangeKeyValue("rangeKeyValue")
                                 .build())
                         .dynamoDBv2(DynamoDBv2Property.builder()
                                 .tableName("tableName")
                                 // the properties below are optional
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .build())
                         .firehose(FirehoseProperty.builder()
                                 .deliveryStreamName("deliveryStreamName")
                                 // the properties below are optional
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .separator("separator")
                                 .build())
                         .iotEvents(IotEventsProperty.builder()
                                 .inputName("inputName")
                                 // the properties below are optional
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .build())
                         .iotSiteWise(IotSiteWiseProperty.builder()
                                 .assetId("assetId")
                                 .entryId("entryId")
                                 .propertyAlias("propertyAlias")
                                 .propertyId("propertyId")
                                 .propertyValue(AssetPropertyValueProperty.builder()
                                         .value(AssetPropertyVariantProperty.builder()
                                                 .booleanValue("booleanValue")
                                                 .doubleValue("doubleValue")
                                                 .integerValue("integerValue")
                                                 .stringValue("stringValue")
                                                 .build())
                                         // the properties below are optional
                                         .quality("quality")
                                         .timestamp(AssetPropertyTimestampProperty.builder()
                                                 .timeInSeconds("timeInSeconds")
                                                 // the properties below are optional
                                                 .offsetInNanos("offsetInNanos")
                                                 .build())
                                         .build())
                                 .build())
                         .iotTopicPublish(IotTopicPublishProperty.builder()
                                 .mqttTopic("mqttTopic")
                                 // the properties below are optional
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .build())
                         .lambda(LambdaProperty.builder()
                                 .functionArn("functionArn")
                                 // the properties below are optional
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .build())
                         .sns(SnsProperty.builder()
                                 .targetArn("targetArn")
                                 // the properties below are optional
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .build())
                         .sqs(SqsProperty.builder()
                                 .queueUrl("queueUrl")
                                 // the properties below are optional
                                 .payload(PayloadProperty.builder()
                                         .contentExpression("contentExpression")
                                         .type("type")
                                         .build())
                                 .useBase64(false)
                                 .build())
                         .build()))
                 .build())
         .alarmModelDescription("alarmModelDescription")
         .alarmModelName("alarmModelName")
         .key("key")
         .severity(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnAlarmModel.AcknowledgeFlowProperty	Specifies whether to get notified for alarm state changes.
static interface	CfnAlarmModel.AlarmActionProperty	Specifies one of the following actions to receive notifications when the alarm state changes.
static interface	CfnAlarmModel.AlarmCapabilitiesProperty	Contains the configuration information of alarm state changes.
static interface	CfnAlarmModel.AlarmEventActionsProperty	Contains information about one or more alarm actions.
static interface	CfnAlarmModel.AlarmRuleProperty	Defines when your alarm is invoked.
static interface	CfnAlarmModel.AssetPropertyTimestampProperty	A structure that contains timestamp information.
static interface	CfnAlarmModel.AssetPropertyValueProperty	A structure that contains value information.
static interface	CfnAlarmModel.AssetPropertyVariantProperty	A structure that contains an asset property value.
static final class	CfnAlarmModel.Builder	A fluent builder for CfnAlarmModel.
static interface	CfnAlarmModel.DynamoDBProperty	Defines an action to write to the Amazon DynamoDB table that you created.
static interface	CfnAlarmModel.DynamoDBv2Property	Defines an action to write to the Amazon DynamoDB table that you created.
static interface	CfnAlarmModel.FirehoseProperty	Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
static interface	CfnAlarmModel.InitializationConfigurationProperty	Specifies the default alarm state.
static interface	CfnAlarmModel.IotEventsProperty	Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
static interface	CfnAlarmModel.IotSiteWiseProperty	Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise .
static interface	CfnAlarmModel.IotTopicPublishProperty	Information required to publish the MQTT message through the AWS IoT message broker.
static interface	CfnAlarmModel.LambdaProperty	Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
static interface	CfnAlarmModel.PayloadProperty	Information needed to configure the payload.
static interface	CfnAlarmModel.SimpleRuleProperty	A rule that compares an input property value to a threshold value with a comparison operator.
static interface	CfnAlarmModel.SnsProperty	Information required to publish the Amazon SNS message.
static interface	CfnAlarmModel.SqsProperty	Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnAlarmModel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAlarmModel(software.amazon.jsii.JsiiObjectRef objRef)
	CfnAlarmModel(software.constructs.Construct scope, String id, CfnAlarmModelProps props)

Method Summary

Modifier and Type	Method	Description
Object	getAlarmCapabilities()	Contains the configuration information of alarm state changes.
Object	getAlarmEventActions()	Contains information about one or more alarm actions.
String	getAlarmModelDescription()	The description of the alarm model.
String	getAlarmModelName()	The name of the alarm model.
Object	getAlarmRule()	Defines when your alarm is invoked.
protected Map<String,Object>	getCfnProperties()
String	getKey()	An input attribute used as a key to create an alarm.
String	getRoleArn()	The ARN of the IAM role that allows the alarm to perform actions and access AWS resources.
Number	getSeverity()	A non-negative integer that reflects the severity level of the alarm.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	A list of key-value pairs that contain metadata for the alarm model.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAlarmCapabilities(IResolvable value)	Contains the configuration information of alarm state changes.
void	setAlarmCapabilities(CfnAlarmModel.AlarmCapabilitiesProperty value)	Contains the configuration information of alarm state changes.
void	setAlarmEventActions(IResolvable value)	Contains information about one or more alarm actions.
void	setAlarmEventActions(CfnAlarmModel.AlarmEventActionsProperty value)	Contains information about one or more alarm actions.
void	setAlarmModelDescription(String value)	The description of the alarm model.
void	setAlarmModelName(String value)	The name of the alarm model.
void	setAlarmRule(IResolvable value)	Defines when your alarm is invoked.
void	setAlarmRule(CfnAlarmModel.AlarmRuleProperty value)	Defines when your alarm is invoked.
void	setKey(String value)	An input attribute used as a key to create an alarm.
void	setRoleArn(String value)	The ARN of the IAM role that allows the alarm to perform actions and access AWS resources.
void	setSeverity(Number value)	A non-negative integer that reflects the severity level of the alarm.
void	setTagsRaw(List<CfnTag> value)	A list of key-value pairs that contain metadata for the alarm model.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnAlarmModel

protected CfnAlarmModel(software.amazon.jsii.JsiiObjectRef objRef)

CfnAlarmModel

protected CfnAlarmModel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAlarmModel

@Stability(Stable)
public CfnAlarmModel(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnAlarmModelProps props)

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.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getAlarmRule

@Stability(Stable)
@NotNull
public Object getAlarmRule()

Defines when your alarm is invoked.

setAlarmRule

@Stability(Stable)
public void setAlarmRule(@NotNull
 IResolvable value)

Defines when your alarm is invoked.

setAlarmRule

@Stability(Stable)
public void setAlarmRule(@NotNull
 CfnAlarmModel.AlarmRuleProperty value)

Defines when your alarm is invoked.

getRoleArn

@Stability(Stable)
@NotNull
public String getRoleArn()

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

setRoleArn

@Stability(Stable)
public void setRoleArn(@NotNull
 String value)

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

getAlarmCapabilities

@Stability(Stable)
@Nullable
public Object getAlarmCapabilities()

Contains the configuration information of alarm state changes.

setAlarmCapabilities

@Stability(Stable)
public void setAlarmCapabilities(@Nullable
 IResolvable value)

Contains the configuration information of alarm state changes.

setAlarmCapabilities

@Stability(Stable)
public void setAlarmCapabilities(@Nullable
 CfnAlarmModel.AlarmCapabilitiesProperty value)

Contains the configuration information of alarm state changes.

getAlarmEventActions

@Stability(Stable)
@Nullable
public Object getAlarmEventActions()

Contains information about one or more alarm actions.

setAlarmEventActions

@Stability(Stable)
public void setAlarmEventActions(@Nullable
 IResolvable value)

Contains information about one or more alarm actions.

setAlarmEventActions

@Stability(Stable)
public void setAlarmEventActions(@Nullable
 CfnAlarmModel.AlarmEventActionsProperty value)

Contains information about one or more alarm actions.

getAlarmModelDescription

@Stability(Stable)
@Nullable
public String getAlarmModelDescription()

The description of the alarm model.

setAlarmModelDescription

@Stability(Stable)
public void setAlarmModelDescription(@Nullable
 String value)

The description of the alarm model.

getAlarmModelName

@Stability(Stable)
@Nullable
public String getAlarmModelName()

The name of the alarm model.

setAlarmModelName

@Stability(Stable)
public void setAlarmModelName(@Nullable
 String value)

The name of the alarm model.

getKey

@Stability(Stable)
@Nullable
public String getKey()

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

setKey

@Stability(Stable)
public void setKey(@Nullable
 String value)

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

getSeverity

@Stability(Stable)
@Nullable
public Number getSeverity()

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

setSeverity

@Stability(Stable)
public void setSeverity(@Nullable
 Number value)

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

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

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

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

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