Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cloudwatch
  5. CompositeAlarm

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.cloudwatch.CompositeAlarm

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

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 CompositeAlarm Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new CompositeAlarm(name: string, args: CompositeAlarmArgs, opts?: CustomResourceOptions);
@overload
def CompositeAlarm(resource_name: str,
                   args: CompositeAlarmArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def CompositeAlarm(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   alarm_rule: Optional[str] = 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,
                   insufficient_data_actions: Optional[Sequence[str]] = None,
                   ok_actions: Optional[Sequence[str]] = None,
                   tags: Optional[Sequence[_root_inputs.TagArgs]] = 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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CompositeAlarmArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. CompositeAlarmArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CompositeAlarmArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The CompositeAlarm resource accepts the following input properties:

AlarmRule This property is required. 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
AlarmName string
The name of the Composite 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).
Tags List<Pulumi.AwsNative.Inputs.Tag>
A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.
AlarmRule This property is required. 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
AlarmName string
The name of the Composite 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).
Tags TagArgs
A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.
alarmRule This property is required. 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
alarmName String
The name of the Composite 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).
tags List<Tag>
A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.
alarmRule This property is required. 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
alarmName string
The name of the Composite 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).
tags Tag[]
A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.
alarm_rule This property is required. 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
alarm_name str
The name of the Composite 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).
ok_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).
tags Sequence[TagArgs]
A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.
alarmRule This property is required. 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
alarmName String
The name of the Composite 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).
tags List<Property Map>
A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.

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.

Supporting Types

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native