AWS Native

v0.29.0 published on Thursday, Sep 8, 2022 by Pulumi

CompositeAlarm

The AWS::CloudWatch::CompositeAlarm type specifies an alarm which aggregates the states of other Alarms (Metric or Composite Alarms) as defined by the AlarmRule expression

Create a CompositeAlarm Resource

new CompositeAlarm(name: string, args: CompositeAlarmArgs, opts?: CustomResourceOptions);
@overload
def CompositeAlarm(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   actions_enabled: Optional[bool] = None,
                   actions_suppressor: Optional[str] = None,
                   actions_suppressor_extension_period: Optional[int] = None,
                   actions_suppressor_wait_period: Optional[int] = None,
                   alarm_actions: Optional[Sequence[str]] = None,
                   alarm_description: Optional[str] = None,
                   alarm_name: Optional[str] = None,
                   alarm_rule: Optional[str] = None,
                   insufficient_data_actions: Optional[Sequence[str]] = None,
                   o_k_actions: Optional[Sequence[str]] = None)
@overload
def CompositeAlarm(resource_name: str,
                   args: CompositeAlarmArgs,
                   opts: Optional[ResourceOptions] = None)
func NewCompositeAlarm(ctx *Context, name string, args CompositeAlarmArgs, opts ...ResourceOption) (*CompositeAlarm, error)
public CompositeAlarm(string name, CompositeAlarmArgs args, CustomResourceOptions? opts = null)
public CompositeAlarm(String name, CompositeAlarmArgs args)
public CompositeAlarm(String name, CompositeAlarmArgs args, CustomResourceOptions options)
type: aws-native:cloudwatch:CompositeAlarm
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args CompositeAlarmArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args CompositeAlarmArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args CompositeAlarmArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CompositeAlarmArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args CompositeAlarmArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

CompositeAlarm Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The CompositeAlarm resource accepts the following input properties:

AlarmName string

The name of the Composite Alarm

AlarmRule string

Expression which aggregates the state of other Alarms (Metric or Composite Alarms)

ActionsEnabled bool

Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

ActionsSuppressor string

Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.

ActionsSuppressorExtensionPeriod int

Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.

ActionsSuppressorWaitPeriod int

Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.

AlarmActions List<string>

The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN).

AlarmDescription string

The description of the alarm

InsufficientDataActions List<string>

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

OKActions List<string>

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

AlarmName string

The name of the Composite Alarm

AlarmRule string

Expression which aggregates the state of other Alarms (Metric or Composite Alarms)

ActionsEnabled bool

Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

ActionsSuppressor string

Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.

ActionsSuppressorExtensionPeriod int

Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.

ActionsSuppressorWaitPeriod int

Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.

AlarmActions []string

The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN).

AlarmDescription string

The description of the alarm

InsufficientDataActions []string

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

OKActions []string

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

alarmName String

The name of the Composite Alarm

alarmRule String

Expression which aggregates the state of other Alarms (Metric or Composite Alarms)

actionsEnabled Boolean

Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

actionsSuppressor String

Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.

actionsSuppressorExtensionPeriod Integer

Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.

actionsSuppressorWaitPeriod Integer

Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.

alarmActions List<String>

The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN).

alarmDescription String

The description of the alarm

insufficientDataActions List<String>

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

oKActions List<String>

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

alarmName string

The name of the Composite Alarm

alarmRule string

Expression which aggregates the state of other Alarms (Metric or Composite Alarms)

actionsEnabled boolean

Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

actionsSuppressor string

Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.

actionsSuppressorExtensionPeriod number

Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.

actionsSuppressorWaitPeriod number

Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.

alarmActions string[]

The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN).

alarmDescription string

The description of the alarm

insufficientDataActions string[]

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

oKActions string[]

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

alarm_name str

The name of the Composite Alarm

alarm_rule str

Expression which aggregates the state of other Alarms (Metric or Composite Alarms)

actions_enabled bool

Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

actions_suppressor str

Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.

actions_suppressor_extension_period int

Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.

actions_suppressor_wait_period int

Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.

alarm_actions Sequence[str]

The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN).

alarm_description str

The description of the alarm

insufficient_data_actions Sequence[str]

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

o_k_actions Sequence[str]

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

alarmName String

The name of the Composite Alarm

alarmRule String

Expression which aggregates the state of other Alarms (Metric or Composite Alarms)

actionsEnabled Boolean

Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

actionsSuppressor String

Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.

actionsSuppressorExtensionPeriod Number

Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.

actionsSuppressorWaitPeriod Number

Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.

alarmActions List<String>

The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN).

alarmDescription String

The description of the alarm

insufficientDataActions List<String>

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

oKActions List<String>

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Outputs

All input properties are implicitly available as output properties. Additionally, the CompositeAlarm resource produces the following output properties:

Arn string

Amazon Resource Name (ARN) of the alarm

Id string

The provider-assigned unique ID for this managed resource.

Arn string

Amazon Resource Name (ARN) of the alarm

Id string

The provider-assigned unique ID for this managed resource.

arn String

Amazon Resource Name (ARN) of the alarm

id String

The provider-assigned unique ID for this managed resource.

arn string

Amazon Resource Name (ARN) of the alarm

id string

The provider-assigned unique ID for this managed resource.

arn str

Amazon Resource Name (ARN) of the alarm

id str

The provider-assigned unique ID for this managed resource.

arn String

Amazon Resource Name (ARN) of the alarm

id String

The provider-assigned unique ID for this managed resource.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0