Class CfnAlarmModel

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnAlarmModel

Implements

IInspectable

IAlarmModelRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.IoTEvents

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnAlarmModel : CfnResource, IInspectable, IAlarmModelRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnAlarmModel Inherits CfnResource Implements IInspectable, IAlarmModelRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

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

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 cfnAlarmModel = new CfnAlarmModel(this, "MyCfnAlarmModel", 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

CfnAlarmModel(Construct, string, ICfnAlarmModelProps)

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

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.
AlarmModelRef	A reference to a AlarmModel resource.
AlarmRule	Defines when your alarm is invoked.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Represents an alarm model to monitor an AWS IoT Events input attribute.
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	Tag Manager which manages the tags for this resource.
TagsRaw	A list of key-value pairs that contain metadata for the alarm model.

Methods

FromAlarmModelName(Construct, string, string)	Creates a new IAlarmModelRef from a alarmModelName.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	Represents an alarm model to monitor an AWS IoT Events input attribute.

Constructors

CfnAlarmModel(Construct, string, ICfnAlarmModelProps)

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

public CfnAlarmModel(Construct scope, string id, ICfnAlarmModelProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnAlarmModelProps: Resource properties.

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

ExampleMetadata: fixture=_generated

Properties

AlarmCapabilities

Contains the configuration information of alarm state changes.

public virtual object? AlarmCapabilities { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnAlarmModel.IAlarmCapabilitiesProperty

AlarmEventActions

Contains information about one or more alarm actions.

public virtual object? AlarmEventActions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnAlarmModel.IAlarmEventActionsProperty

AlarmModelDescription

The description of the alarm model.

public virtual string? AlarmModelDescription { get; set; }

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

ExampleMetadata: fixture=_generated

AlarmModelName

The name of the alarm model.

public virtual string? AlarmModelName { get; set; }

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

ExampleMetadata: fixture=_generated

AlarmModelRef

A reference to a AlarmModel resource.

public virtual IAlarmModelReference AlarmModelRef { get; }

Property Value

IAlarmModelReference

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

ExampleMetadata: fixture=_generated

AlarmRule

Defines when your alarm is invoked.

public virtual object AlarmRule { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnAlarmModel.IAlarmRuleProperty

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { 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

ExampleMetadata: fixture=_generated

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

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

ExampleMetadata: fixture=_generated

Key

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

public virtual string? Key { get; set; }

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

ExampleMetadata: fixture=_generated

RoleArn

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

public virtual string RoleArn { get; set; }

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

ExampleMetadata: fixture=_generated

Severity

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

public virtual double? Severity { get; set; }

Property Value

double?

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

ExampleMetadata: fixture=_generated

TagsRaw

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

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

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

ExampleMetadata: fixture=_generated

Methods

FromAlarmModelName(Construct, string, string)

Creates a new IAlarmModelRef from a alarmModelName.

public static IAlarmModelRef FromAlarmModelName(Construct scope, string id, string alarmModelName)

Parameters

scope Construct
id string
alarmModelName string

Returns

IAlarmModelRef

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

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

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

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

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

ExampleMetadata: fixture=_generated

Implements

IInspectable

IAlarmModelRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable