Class CfnCompositeAlarmProps

Properties for defining a CfnCompositeAlarm.

Inheritance

object

CfnCompositeAlarmProps

Implements

ICfnCompositeAlarmProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.CloudWatch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnCompositeAlarmProps : ICfnCompositeAlarmProps

Syntax (vb)

Public Class CfnCompositeAlarmProps Implements ICfnCompositeAlarmProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.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.CloudWatch;

             var cfnCompositeAlarmProps = new CfnCompositeAlarmProps {
                 AlarmRule = "alarmRule",

                 // the properties below are optional
                 ActionsEnabled = false,
                 ActionsSuppressor = "actionsSuppressor",
                 ActionsSuppressorExtensionPeriod = 123,
                 ActionsSuppressorWaitPeriod = 123,
                 AlarmActions = new [] { "alarmActions" },
                 AlarmDescription = "alarmDescription",
                 AlarmName = "alarmName",
                 InsufficientDataActions = new [] { "insufficientDataActions" },
                 OkActions = new [] { "okActions" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnCompositeAlarmProps()

Properties for defining a CfnCompositeAlarm.

Properties

ActionsEnabled	Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.
ActionsSuppressor	Actions will be suppressed if the suppressor alarm is in the `ALARM` state.
ActionsSuppressorExtensionPeriod	The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the `ALARM` state.
ActionsSuppressorWaitPeriod	The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the `ALARM` state.
AlarmActions	The actions to execute when this alarm transitions to the ALARM state from any other state.
AlarmDescription	The description for the composite alarm.
AlarmName	The name for the composite alarm.
AlarmRule	An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state.
InsufficientDataActions	The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
OkActions	The actions to execute when this alarm transitions to the OK state from any other state.
Tags	A list of key-value pairs to associate with the alarm.

Constructors

CfnCompositeAlarmProps()

Properties for defining a CfnCompositeAlarm.

public CfnCompositeAlarmProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.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.CloudWatch;

             var cfnCompositeAlarmProps = new CfnCompositeAlarmProps {
                 AlarmRule = "alarmRule",

                 // the properties below are optional
                 ActionsEnabled = false,
                 ActionsSuppressor = "actionsSuppressor",
                 ActionsSuppressorExtensionPeriod = 123,
                 ActionsSuppressorWaitPeriod = 123,
                 AlarmActions = new [] { "alarmActions" },
                 AlarmDescription = "alarmDescription",
                 AlarmName = "alarmName",
                 InsufficientDataActions = new [] { "insufficientDataActions" },
                 OkActions = new [] { "okActions" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

ActionsEnabled

Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.

public object? ActionsEnabled { get; set; }

Property Value

object

Remarks

The default is TRUE.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionsenabled

ActionsSuppressor

Actions will be suppressed if the suppressor alarm is in the ALARM state.

public string? ActionsSuppressor { get; set; }

Property Value

string

Remarks

ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionssuppressor

ActionsSuppressorExtensionPeriod

The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM state.

public double? ActionsSuppressorExtensionPeriod { get; set; }

Property Value

double?

Remarks

After this time, the composite alarm performs its actions.

<code>ExtensionPeriod</code> is required only when <code>ActionsSuppressor</code> is specified.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionssuppressorextensionperiod

ActionsSuppressorWaitPeriod

The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM state.

public double? ActionsSuppressorWaitPeriod { get; set; }

Property Value

double?

Remarks

After this time, the composite alarm performs its actions.

<code>WaitPeriod</code> is required only when <code>ActionsSuppressor</code> is specified.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionssuppressorwaitperiod

AlarmActions

The actions to execute when this alarm transitions to the ALARM state from any other state.

public string[]? AlarmActions { get; set; }

Property Value

string[]

Remarks

Each action is specified as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see PutCompositeAlarm in the Amazon CloudWatch API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmactions

AlarmDescription

The description for the composite alarm.

public string? AlarmDescription { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmdescription

AlarmName

The name for the composite alarm.

public string? AlarmName { get; set; }

Property Value

string

Remarks

This name must be unique within your AWS account.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmname

AlarmRule

An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state.

public string AlarmRule { get; set; }

Property Value

string

Remarks

For each alarm that you reference, you designate a function that specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the functions in your expression.

You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.

Functions can include the following:

TRUE and FALSE are useful for testing a complex AlarmRule structure, and for testing your alarm actions.

For more information about AlarmRule syntax, see PutCompositeAlarm in the Amazon CloudWatch API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmrule

InsufficientDataActions

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.

public string[]? InsufficientDataActions { get; set; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-insufficientdataactions

OkActions

The actions to execute when this alarm transitions to the OK state from any other state.

public string[]? OkActions { get; set; }