Class CfnAlarmModelProps
Properties for defining a CfnAlarmModel
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.IoTEvents
Assembly: Amazon.CDK.AWS.IoTEvents.dll
Syntax (csharp)
public class CfnAlarmModelProps : Object, ICfnAlarmModelProps
Syntax (vb)
Public Class CfnAlarmModelProps
Inherits Object
Implements ICfnAlarmModelProps
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html
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.AWS.IoTEvents;
var cfnAlarmModelProps = new CfnAlarmModelProps {
AlarmRule = new AlarmRuleProperty {
SimpleRule = new SimpleRuleProperty {
ComparisonOperator = "comparisonOperator",
InputProperty = "inputProperty",
Threshold = "threshold"
}
},
RoleArn = "roleArn",
// the properties below are optional
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",
HashKeyValue = "hashKeyValue",
TableName = "tableName",
// the properties below are optional
HashKeyType = "hashKeyType",
Operation = "operation",
Payload = new PayloadProperty {
ContentExpression = "contentExpression",
Type = "type"
},
PayloadField = "payloadField",
RangeKeyField = "rangeKeyField",
RangeKeyType = "rangeKeyType",
RangeKeyValue = "rangeKeyValue"
},
DynamoDBv2 = new DynamoDBv2Property {
TableName = "tableName",
// the properties below are optional
Payload = new PayloadProperty {
ContentExpression = "contentExpression",
Type = "type"
}
},
Firehose = new FirehoseProperty {
DeliveryStreamName = "deliveryStreamName",
// the properties below are optional
Payload = new PayloadProperty {
ContentExpression = "contentExpression",
Type = "type"
},
Separator = "separator"
},
IotEvents = new IotEventsProperty {
InputName = "inputName",
// the properties below are optional
Payload = new PayloadProperty {
ContentExpression = "contentExpression",
Type = "type"
}
},
IotSiteWise = new IotSiteWiseProperty {
AssetId = "assetId",
EntryId = "entryId",
PropertyAlias = "propertyAlias",
PropertyId = "propertyId",
PropertyValue = new AssetPropertyValueProperty {
Value = new AssetPropertyVariantProperty {
BooleanValue = "booleanValue",
DoubleValue = "doubleValue",
IntegerValue = "integerValue",
StringValue = "stringValue"
},
// the properties below are optional
Quality = "quality",
Timestamp = new AssetPropertyTimestampProperty {
TimeInSeconds = "timeInSeconds",
// the properties below are optional
OffsetInNanos = "offsetInNanos"
}
}
},
IotTopicPublish = new IotTopicPublishProperty {
MqttTopic = "mqttTopic",
// the properties below are optional
Payload = new PayloadProperty {
ContentExpression = "contentExpression",
Type = "type"
}
},
Lambda = new LambdaProperty {
FunctionArn = "functionArn",
// the properties below are optional
Payload = new PayloadProperty {
ContentExpression = "contentExpression",
Type = "type"
}
},
Sns = new SnsProperty {
TargetArn = "targetArn",
// the properties below are optional
Payload = new PayloadProperty {
ContentExpression = "contentExpression",
Type = "type"
}
},
Sqs = new SqsProperty {
QueueUrl = "queueUrl",
// the properties below are optional
Payload = new PayloadProperty {
ContentExpression = "contentExpression",
Type = "type"
},
UseBase64 = false
}
} }
},
AlarmModelDescription = "alarmModelDescription",
AlarmModelName = "alarmModelName",
Key = "key",
Severity = 123,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Constructors
CfnAlarmModelProps() |
Properties
AlarmCapabilities | Contains the configuration information of alarm state changes. |
AlarmEventActions | Contains information about one or more alarm actions. |
AlarmModelDescription | The description of the alarm model. |
AlarmModelName | The name of the alarm model. |
AlarmRule | Defines when your alarm is invoked. |
Key | An input attribute used as a key to create an alarm. |
RoleArn | The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. |
Severity | A non-negative integer that reflects the severity level of the alarm. |
Tags | A list of key-value pairs that contain metadata for the alarm model. |
Constructors
CfnAlarmModelProps()
public CfnAlarmModelProps()
Properties
AlarmCapabilities
Contains the configuration information of alarm state changes.
public object AlarmCapabilities { get; set; }
Property Value
System.Object
Remarks
AlarmEventActions
Contains information about one or more alarm actions.
public object AlarmEventActions { get; set; }
Property Value
System.Object
Remarks
AlarmModelDescription
The description of the alarm model.
public string AlarmModelDescription { get; set; }
Property Value
System.String
Remarks
AlarmModelName
The name of the alarm model.
public string AlarmModelName { get; set; }
Property Value
System.String
Remarks
AlarmRule
Defines when your alarm is invoked.
public object AlarmRule { get; set; }
Property Value
System.Object
Remarks
Key
An input attribute used as a key to create an alarm.
public string Key { get; set; }
Property Value
System.String
Remarks
AWS IoT Events routes inputs associated with this key to the alarm.
RoleArn
The ARN of the IAM role that allows the alarm to perform actions and access AWS resources.
public string RoleArn { get; set; }
Property Value
System.String
Remarks
For more information, see Amazon Resource Names (ARNs) in the AWS General Reference .
Severity
A non-negative integer that reflects the severity level of the alarm.
public Nullable<double> Severity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Tags
A list of key-value pairs that contain metadata for the alarm model.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
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.