We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
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,
action_configuration: Optional[CompositeAlarmActionConfigurationArgs] = 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.
resource "aws-native_cloudwatch_composite_alarm" "name" {
# resource properties
}Parameters
- 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
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:
- Alarm
Rule string - Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
- Action
Configuration Pulumi.Aws Native. Cloud Watch. Inputs. Composite Alarm Action Configuration - Configuration that applies to the notifications this alarm sends when it performs its actions.
- Actions
Enabled bool - Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
- Actions
Suppressor 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.
- Actions
Suppressor intExtension Period - Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.
- Actions
Suppressor intWait Period - Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.
- Alarm
Actions 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).
- Alarm
Description string - The description of the alarm
- Alarm
Name string - The name of the Composite Alarm
- Insufficient
Data List<string>Actions - 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 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).
-
List<Pulumi.
Aws Native. 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.
- Alarm
Rule string - Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
- Action
Configuration CompositeAlarm Action Configuration Args - Configuration that applies to the notifications this alarm sends when it performs its actions.
- Actions
Enabled bool - Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
- Actions
Suppressor 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.
- Actions
Suppressor intExtension Period - Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.
- Actions
Suppressor intWait Period - Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.
- Alarm
Actions []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).
- Alarm
Description string - The description of the alarm
- Alarm
Name string - The name of the Composite Alarm
- Insufficient
Data []stringActions - 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 []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).
-
Tag
Args - 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 string - Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
- action_
configuration object - Configuration that applies to the notifications this alarm sends when it performs its actions.
- actions_
enabled bool - Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
- actions_
suppressor 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.
- actions_
suppressor_ numberextension_ period - Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.
- actions_
suppressor_ numberwait_ period - Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.
- alarm_
actions 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).
- alarm_
description string - The description of the alarm
- alarm_
name string - The name of the Composite Alarm
- insufficient_
data_ list(string)actions - 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 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).
- list(object)
- 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 String - Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
- action
Configuration CompositeAlarm Action Configuration - Configuration that applies to the notifications this alarm sends when it performs its actions.
- actions
Enabled Boolean - Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
- actions
Suppressor 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.
- actions
Suppressor IntegerExtension Period - Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.
- actions
Suppressor IntegerWait Period - Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.
- alarm
Actions 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).
- alarm
Description String - The description of the alarm
- alarm
Name String - The name of the Composite Alarm
- insufficient
Data List<String>Actions - 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 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).
- 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.
- alarm
Rule string - Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
- action
Configuration CompositeAlarm Action Configuration - Configuration that applies to the notifications this alarm sends when it performs its actions.
- actions
Enabled boolean - Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
- actions
Suppressor 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.
- actions
Suppressor numberExtension Period - Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.
- actions
Suppressor numberWait Period - Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.
- alarm
Actions 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).
- alarm
Description string - The description of the alarm
- alarm
Name string - The name of the Composite Alarm
- insufficient
Data string[]Actions - 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 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).
- 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 str - Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
- action_
configuration CompositeAlarm Action Configuration Args - Configuration that applies to the notifications this alarm sends when it performs its actions.
- 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_ intextension_ period - Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.
- actions_
suppressor_ intwait_ period - 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_ Sequence[str]actions - 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).
-
Sequence[Tag
Args] - 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 String - Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
- action
Configuration Property Map - Configuration that applies to the notifications this alarm sends when it performs its actions.
- actions
Enabled Boolean - Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
- actions
Suppressor 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.
- actions
Suppressor NumberExtension Period - Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.
- actions
Suppressor NumberWait Period - Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.
- alarm
Actions 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).
- alarm
Description String - The description of the alarm
- alarm
Name String - The name of the Composite Alarm
- insufficient
Data List<String>Actions - 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 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).
- 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:
Look up Existing CompositeAlarm Resource
Get an existing CompositeAlarm resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): CompositeAlarm@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> CompositeAlarmfunc GetCompositeAlarm(ctx *Context, name string, id IDInput, state *CompositeAlarmState, opts ...ResourceOption) (*CompositeAlarm, error)public static CompositeAlarm Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static CompositeAlarm get(String name, Output<String> id, CustomResourceOptions options)resources: existingCompositeAlarm: type: aws-native:cloudwatch:CompositeAlarm get: id: ${id}import {
to = aws-native_cloudwatch_composite_alarm.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state CompositeAlarmState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
CompositeAlarmActionConfiguration, CompositeAlarmActionConfigurationArgs
Configuration that applies to the notifications this alarm sends when it performs its actions.
-
Pulumi.
Aws Native. Cloud Watch. Inputs. Composite Alarm Alarm Tags Propagation - Whether the alarm's tags are included in its action notifications and state-change events.
-
Composite
Alarm Alarm Tags Propagation - Whether the alarm's tags are included in its action notifications and state-change events.
- object
- Whether the alarm's tags are included in its action notifications and state-change events.
-
Composite
Alarm Alarm Tags Propagation - Whether the alarm's tags are included in its action notifications and state-change events.
-
Composite
Alarm Alarm Tags Propagation - Whether the alarm's tags are included in its action notifications and state-change events.
-
Composite
Alarm Alarm Tags Propagation - Whether the alarm's tags are included in its action notifications and state-change events.
- Property Map
- Whether the alarm's tags are included in its action notifications and state-change events.
CompositeAlarmAlarmTagsPropagation, CompositeAlarmAlarmTagsPropagationArgs
Controls whether the alarm's tags are included in its action notifications and state-change events, and which tag keys are included. Specify IncludedTagKeys or ExcludedTagKeys, but not both. Omit both to include every tag.
- Enabled bool
- Whether the alarm's tags are included in its action notifications and state-change events.
- Excluded
Tag List<string>Keys - The tag keys to leave out. Cannot be specified together with IncludedTagKeys.
- Included
Tag List<string>Keys - The only tag keys to include. Cannot be specified together with ExcludedTagKeys.
- Enabled bool
- Whether the alarm's tags are included in its action notifications and state-change events.
- Excluded
Tag []stringKeys - The tag keys to leave out. Cannot be specified together with IncludedTagKeys.
- Included
Tag []stringKeys - The only tag keys to include. Cannot be specified together with ExcludedTagKeys.
- enabled bool
- Whether the alarm's tags are included in its action notifications and state-change events.
- excluded_
tag_ list(string)keys - The tag keys to leave out. Cannot be specified together with IncludedTagKeys.
- included_
tag_ list(string)keys - The only tag keys to include. Cannot be specified together with ExcludedTagKeys.
- enabled Boolean
- Whether the alarm's tags are included in its action notifications and state-change events.
- excluded
Tag List<String>Keys - The tag keys to leave out. Cannot be specified together with IncludedTagKeys.
- included
Tag List<String>Keys - The only tag keys to include. Cannot be specified together with ExcludedTagKeys.
- enabled boolean
- Whether the alarm's tags are included in its action notifications and state-change events.
- excluded
Tag string[]Keys - The tag keys to leave out. Cannot be specified together with IncludedTagKeys.
- included
Tag string[]Keys - The only tag keys to include. Cannot be specified together with ExcludedTagKeys.
- enabled bool
- Whether the alarm's tags are included in its action notifications and state-change events.
- excluded_
tag_ Sequence[str]keys - The tag keys to leave out. Cannot be specified together with IncludedTagKeys.
- included_
tag_ Sequence[str]keys - The only tag keys to include. Cannot be specified together with ExcludedTagKeys.
- enabled Boolean
- Whether the alarm's tags are included in its action notifications and state-change events.
- excluded
Tag List<String>Keys - The tag keys to leave out. Cannot be specified together with IncludedTagKeys.
- included
Tag List<String>Keys - The only tag keys to include. Cannot be specified together with ExcludedTagKeys.
Tag, TagArgs
A set of tags to apply to the resource.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi