Show / Hide Table of Contents

Class CfnAlarmModelPropsMixin

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

Inheritance
object
Mixin
CfnAlarmModelPropsMixin
Implements
IMixin
Inherited Members
Mixin.IsMixin(object)
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.IoTEvents
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnAlarmModelPropsMixin : Mixin, IMixin
Syntax (vb)
Public Class CfnAlarmModelPropsMixin Inherits Mixin Implements IMixin
Remarks

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 .

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

CloudformationResource: AWS::IoTEvents::AlarmModel

Mixin: true

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.IoTEvents;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnAlarmModelPropsMixin = new CfnAlarmModelPropsMixin(new CfnAlarmModelMixinProps {
                 AlarmCapabilities = new AlarmCapabilitiesProperty {
                     AcknowledgeFlow = new AcknowledgeFlowProperty {
                         Enabled = false
                     },
                     InitializationConfiguration = new InitializationConfigurationProperty {
                         DisabledOnInitialization = false
                     }
                 },
                 AlarmEventActions = new AlarmEventActionsProperty {
                     AlarmActions = new [] { new AlarmActionProperty {
                         DynamoDb = new DynamoDBProperty {
                             HashKeyField = "hashKeyField",
                             HashKeyType = "hashKeyType",
                             HashKeyValue = "hashKeyValue",
                             Operation = "operation",
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             },
                             PayloadField = "payloadField",
                             RangeKeyField = "rangeKeyField",
                             RangeKeyType = "rangeKeyType",
                             RangeKeyValue = "rangeKeyValue",
                             TableName = "tableName"
                         },
                         DynamoDBv2 = new DynamoDBv2Property {
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             },
                             TableName = "tableName"
                         },
                         Firehose = new FirehoseProperty {
                             DeliveryStreamName = "deliveryStreamName",
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             },
                             Separator = "separator"
                         },
                         IotEvents = new IotEventsProperty {
                             InputName = "inputName",
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             }
                         },
                         IotSiteWise = new IotSiteWiseProperty {
                             AssetId = "assetId",
                             EntryId = "entryId",
                             PropertyAlias = "propertyAlias",
                             PropertyId = "propertyId",
                             PropertyValue = new AssetPropertyValueProperty {
                                 Quality = "quality",
                                 Timestamp = new AssetPropertyTimestampProperty {
                                     OffsetInNanos = "offsetInNanos",
                                     TimeInSeconds = "timeInSeconds"
                                 },
                                 Value = new AssetPropertyVariantProperty {
                                     BooleanValue = "booleanValue",
                                     DoubleValue = "doubleValue",
                                     IntegerValue = "integerValue",
                                     StringValue = "stringValue"
                                 }
                             }
                         },
                         IotTopicPublish = new IotTopicPublishProperty {
                             MqttTopic = "mqttTopic",
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             }
                         },
                         Lambda = new LambdaProperty {
                             FunctionArn = "functionArn",
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             }
                         },
                         Sns = new SnsProperty {
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             },
                             TargetArn = "targetArn"
                         },
                         Sqs = new SqsProperty {
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             },
                             QueueUrl = "queueUrl",
                             UseBase64 = false
                         }
                     } }
                 },
                 AlarmModelDescription = "alarmModelDescription",
                 AlarmModelName = "alarmModelName",
                 AlarmRule = new AlarmRuleProperty {
                     SimpleRule = new SimpleRuleProperty {
                         ComparisonOperator = "comparisonOperator",
                         InputProperty = "inputProperty",
                         Threshold = "threshold"
                     }
                 },
                 Key = "key",
                 RoleArn = "roleArn",
                 Severity = 123,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Synopsis

Constructors

CfnAlarmModelPropsMixin(ICfnAlarmModelMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::IoTEvents::AlarmModel.

Properties

CFN_PROPERTY_KEYS

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

Props

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

Strategy

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

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

Supports(IConstruct)

Check if this mixin supports the given construct.

Constructors

CfnAlarmModelPropsMixin(ICfnAlarmModelMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::IoTEvents::AlarmModel.

public CfnAlarmModelPropsMixin(ICfnAlarmModelMixinProps props, ICfnPropertyMixinOptions? options = null)
Parameters
props ICfnAlarmModelMixinProps

L1 properties to apply.

options ICfnPropertyMixinOptions

Mixin options.

Remarks

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 .

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

CloudformationResource: AWS::IoTEvents::AlarmModel

Mixin: true

ExampleMetadata: fixture=_generated

Properties

CFN_PROPERTY_KEYS

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

protected static string[] CFN_PROPERTY_KEYS { get; }
Property Value

string[]

Remarks

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 .

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

CloudformationResource: AWS::IoTEvents::AlarmModel

Mixin: true

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.IoTEvents;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnAlarmModelPropsMixin = new CfnAlarmModelPropsMixin(new CfnAlarmModelMixinProps {
                 AlarmCapabilities = new AlarmCapabilitiesProperty {
                     AcknowledgeFlow = new AcknowledgeFlowProperty {
                         Enabled = false
                     },
                     InitializationConfiguration = new InitializationConfigurationProperty {
                         DisabledOnInitialization = false
                     }
                 },
                 AlarmEventActions = new AlarmEventActionsProperty {
                     AlarmActions = new [] { new AlarmActionProperty {
                         DynamoDb = new DynamoDBProperty {
                             HashKeyField = "hashKeyField",
                             HashKeyType = "hashKeyType",
                             HashKeyValue = "hashKeyValue",
                             Operation = "operation",
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             },
                             PayloadField = "payloadField",
                             RangeKeyField = "rangeKeyField",
                             RangeKeyType = "rangeKeyType",
                             RangeKeyValue = "rangeKeyValue",
                             TableName = "tableName"
                         },
                         DynamoDBv2 = new DynamoDBv2Property {
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             },
                             TableName = "tableName"
                         },
                         Firehose = new FirehoseProperty {
                             DeliveryStreamName = "deliveryStreamName",
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             },
                             Separator = "separator"
                         },
                         IotEvents = new IotEventsProperty {
                             InputName = "inputName",
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             }
                         },
                         IotSiteWise = new IotSiteWiseProperty {
                             AssetId = "assetId",
                             EntryId = "entryId",
                             PropertyAlias = "propertyAlias",
                             PropertyId = "propertyId",
                             PropertyValue = new AssetPropertyValueProperty {
                                 Quality = "quality",
                                 Timestamp = new AssetPropertyTimestampProperty {
                                     OffsetInNanos = "offsetInNanos",
                                     TimeInSeconds = "timeInSeconds"
                                 },
                                 Value = new AssetPropertyVariantProperty {
                                     BooleanValue = "booleanValue",
                                     DoubleValue = "doubleValue",
                                     IntegerValue = "integerValue",
                                     StringValue = "stringValue"
                                 }
                             }
                         },
                         IotTopicPublish = new IotTopicPublishProperty {
                             MqttTopic = "mqttTopic",
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             }
                         },
                         Lambda = new LambdaProperty {
                             FunctionArn = "functionArn",
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             }
                         },
                         Sns = new SnsProperty {
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             },
                             TargetArn = "targetArn"
                         },
                         Sqs = new SqsProperty {
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             },
                             QueueUrl = "queueUrl",
                             UseBase64 = false
                         }
                     } }
                 },
                 AlarmModelDescription = "alarmModelDescription",
                 AlarmModelName = "alarmModelName",
                 AlarmRule = new AlarmRuleProperty {
                     SimpleRule = new SimpleRuleProperty {
                         ComparisonOperator = "comparisonOperator",
                         InputProperty = "inputProperty",
                         Threshold = "threshold"
                     }
                 },
                 Key = "key",
                 RoleArn = "roleArn",
                 Severity = 123,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Props

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

protected virtual ICfnAlarmModelMixinProps Props { get; }
Property Value

ICfnAlarmModelMixinProps

Remarks

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 .

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

CloudformationResource: AWS::IoTEvents::AlarmModel

Mixin: true

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.IoTEvents;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnAlarmModelPropsMixin = new CfnAlarmModelPropsMixin(new CfnAlarmModelMixinProps {
                 AlarmCapabilities = new AlarmCapabilitiesProperty {
                     AcknowledgeFlow = new AcknowledgeFlowProperty {
                         Enabled = false
                     },
                     InitializationConfiguration = new InitializationConfigurationProperty {
                         DisabledOnInitialization = false
                     }
                 },
                 AlarmEventActions = new AlarmEventActionsProperty {
                     AlarmActions = new [] { new AlarmActionProperty {
                         DynamoDb = new DynamoDBProperty {
                             HashKeyField = "hashKeyField",
                             HashKeyType = "hashKeyType",
                             HashKeyValue = "hashKeyValue",
                             Operation = "operation",
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             },
                             PayloadField = "payloadField",
                             RangeKeyField = "rangeKeyField",
                             RangeKeyType = "rangeKeyType",
                             RangeKeyValue = "rangeKeyValue",
                             TableName = "tableName"
                         },
                         DynamoDBv2 = new DynamoDBv2Property {
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             },
                             TableName = "tableName"
                         },
                         Firehose = new FirehoseProperty {
                             DeliveryStreamName = "deliveryStreamName",
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             },
                             Separator = "separator"
                         },
                         IotEvents = new IotEventsProperty {
                             InputName = "inputName",
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             }
                         },
                         IotSiteWise = new IotSiteWiseProperty {
                             AssetId = "assetId",
                             EntryId = "entryId",
                             PropertyAlias = "propertyAlias",
                             PropertyId = "propertyId",
                             PropertyValue = new AssetPropertyValueProperty {
                                 Quality = "quality",
                                 Timestamp = new AssetPropertyTimestampProperty {
                                     OffsetInNanos = "offsetInNanos",
                                     TimeInSeconds = "timeInSeconds"
                                 },
                                 Value = new AssetPropertyVariantProperty {
                                     BooleanValue = "booleanValue",
                                     DoubleValue = "doubleValue",
                                     IntegerValue = "integerValue",
                                     StringValue = "stringValue"
                                 }
                             }
                         },
                         IotTopicPublish = new IotTopicPublishProperty {
                             MqttTopic = "mqttTopic",
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             }
                         },
                         Lambda = new LambdaProperty {
                             FunctionArn = "functionArn",
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             }
                         },
                         Sns = new SnsProperty {
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             },
                             TargetArn = "targetArn"
                         },
                         Sqs = new SqsProperty {
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             },
                             QueueUrl = "queueUrl",
                             UseBase64 = false
                         }
                     } }
                 },
                 AlarmModelDescription = "alarmModelDescription",
                 AlarmModelName = "alarmModelName",
                 AlarmRule = new AlarmRuleProperty {
                     SimpleRule = new SimpleRuleProperty {
                         ComparisonOperator = "comparisonOperator",
                         InputProperty = "inputProperty",
                         Threshold = "threshold"
                     }
                 },
                 Key = "key",
                 RoleArn = "roleArn",
                 Severity = 123,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Strategy

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

protected virtual IMergeStrategy Strategy { get; }
Property Value

IMergeStrategy

Remarks

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 .

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

CloudformationResource: AWS::IoTEvents::AlarmModel

Mixin: true

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.IoTEvents;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnAlarmModelPropsMixin = new CfnAlarmModelPropsMixin(new CfnAlarmModelMixinProps {
                 AlarmCapabilities = new AlarmCapabilitiesProperty {
                     AcknowledgeFlow = new AcknowledgeFlowProperty {
                         Enabled = false
                     },
                     InitializationConfiguration = new InitializationConfigurationProperty {
                         DisabledOnInitialization = false
                     }
                 },
                 AlarmEventActions = new AlarmEventActionsProperty {
                     AlarmActions = new [] { new AlarmActionProperty {
                         DynamoDb = new DynamoDBProperty {
                             HashKeyField = "hashKeyField",
                             HashKeyType = "hashKeyType",
                             HashKeyValue = "hashKeyValue",
                             Operation = "operation",
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             },
                             PayloadField = "payloadField",
                             RangeKeyField = "rangeKeyField",
                             RangeKeyType = "rangeKeyType",
                             RangeKeyValue = "rangeKeyValue",
                             TableName = "tableName"
                         },
                         DynamoDBv2 = new DynamoDBv2Property {
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             },
                             TableName = "tableName"
                         },
                         Firehose = new FirehoseProperty {
                             DeliveryStreamName = "deliveryStreamName",
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             },
                             Separator = "separator"
                         },
                         IotEvents = new IotEventsProperty {
                             InputName = "inputName",
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             }
                         },
                         IotSiteWise = new IotSiteWiseProperty {
                             AssetId = "assetId",
                             EntryId = "entryId",
                             PropertyAlias = "propertyAlias",
                             PropertyId = "propertyId",
                             PropertyValue = new AssetPropertyValueProperty {
                                 Quality = "quality",
                                 Timestamp = new AssetPropertyTimestampProperty {
                                     OffsetInNanos = "offsetInNanos",
                                     TimeInSeconds = "timeInSeconds"
                                 },
                                 Value = new AssetPropertyVariantProperty {
                                     BooleanValue = "booleanValue",
                                     DoubleValue = "doubleValue",
                                     IntegerValue = "integerValue",
                                     StringValue = "stringValue"
                                 }
                             }
                         },
                         IotTopicPublish = new IotTopicPublishProperty {
                             MqttTopic = "mqttTopic",
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             }
                         },
                         Lambda = new LambdaProperty {
                             FunctionArn = "functionArn",
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             }
                         },
                         Sns = new SnsProperty {
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             },
                             TargetArn = "targetArn"
                         },
                         Sqs = new SqsProperty {
                             Payload = new PayloadProperty {
                                 ContentExpression = "contentExpression",
                                 Type = "type"
                             },
                             QueueUrl = "queueUrl",
                             UseBase64 = false
                         }
                     } }
                 },
                 AlarmModelDescription = "alarmModelDescription",
                 AlarmModelName = "alarmModelName",
                 AlarmRule = new AlarmRuleProperty {
                     SimpleRule = new SimpleRuleProperty {
                         ComparisonOperator = "comparisonOperator",
                         InputProperty = "inputProperty",
                         Threshold = "threshold"
                     }
                 },
                 Key = "key",
                 RoleArn = "roleArn",
                 Severity = 123,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

public override void ApplyTo(IConstruct construct)
Parameters
construct IConstruct
Overrides
Mixin.ApplyTo(IConstruct)
Remarks

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 .

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

CloudformationResource: AWS::IoTEvents::AlarmModel

Mixin: true

ExampleMetadata: fixture=_generated

Supports(IConstruct)

Check if this mixin supports the given construct.

public override bool Supports(IConstruct construct)
Parameters
construct IConstruct
Returns

bool

Overrides
Mixin.Supports(IConstruct)
Remarks

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 .

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

CloudformationResource: AWS::IoTEvents::AlarmModel

Mixin: true

ExampleMetadata: fixture=_generated

Implements

Constructs.IMixin
Back to top Generated by DocFX