1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. cloudwatch
  6. CompositeAlarm

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

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

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

Viewing docs for AWS Cloud Control v1.86.0
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:

    AlarmRule string
    Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
    ActionConfiguration Pulumi.AwsNative.CloudWatch.Inputs.CompositeAlarmActionConfiguration
    Configuration that applies to the notifications this alarm sends when it performs its actions.
    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 string
    Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
    ActionConfiguration CompositeAlarmActionConfigurationArgs
    Configuration that applies to the notifications this alarm sends when it performs its actions.
    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.
    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_extension_period number
    Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.
    actions_suppressor_wait_period number
    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_actions 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).
    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).
    tags 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.
    alarmRule String
    Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
    actionConfiguration CompositeAlarmActionConfiguration
    Configuration that applies to the notifications this alarm sends when it performs its actions.
    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 string
    Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
    actionConfiguration CompositeAlarmActionConfiguration
    Configuration that applies to the notifications this alarm sends when it performs its actions.
    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 str
    Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
    action_configuration CompositeAlarmActionConfigurationArgs
    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_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 String
    Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
    actionConfiguration Property Map
    Configuration that applies to the notifications this alarm sends when it performs its actions.
    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 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.

    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) -> CompositeAlarm
    func 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.

    AlarmTagsPropagation Pulumi.AwsNative.CloudWatch.Inputs.CompositeAlarmAlarmTagsPropagation
    Whether the alarm's tags are included in its action notifications and state-change events.
    AlarmTagsPropagation CompositeAlarmAlarmTagsPropagation
    Whether the alarm's tags are included in its action notifications and state-change events.
    alarm_tags_propagation object
    Whether the alarm's tags are included in its action notifications and state-change events.
    alarmTagsPropagation CompositeAlarmAlarmTagsPropagation
    Whether the alarm's tags are included in its action notifications and state-change events.
    alarmTagsPropagation CompositeAlarmAlarmTagsPropagation
    Whether the alarm's tags are included in its action notifications and state-change events.
    alarm_tags_propagation CompositeAlarmAlarmTagsPropagation
    Whether the alarm's tags are included in its action notifications and state-change events.
    alarmTagsPropagation 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.
    ExcludedTagKeys List<string>
    The tag keys to leave out. Cannot be specified together with IncludedTagKeys.
    IncludedTagKeys List<string>
    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.
    ExcludedTagKeys []string
    The tag keys to leave out. Cannot be specified together with IncludedTagKeys.
    IncludedTagKeys []string
    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_keys list(string)
    The tag keys to leave out. Cannot be specified together with IncludedTagKeys.
    included_tag_keys list(string)
    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.
    excludedTagKeys List<String>
    The tag keys to leave out. Cannot be specified together with IncludedTagKeys.
    includedTagKeys List<String>
    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.
    excludedTagKeys string[]
    The tag keys to leave out. Cannot be specified together with IncludedTagKeys.
    includedTagKeys string[]
    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_keys Sequence[str]
    The tag keys to leave out. Cannot be specified together with IncludedTagKeys.
    included_tag_keys Sequence[str]
    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.
    excludedTagKeys List<String>
    The tag keys to leave out. Cannot be specified together with IncludedTagKeys.
    includedTagKeys List<String>
    The only tag keys to include. Cannot be specified together with ExcludedTagKeys.

    Tag, TagArgs

    A set of tags to apply to the resource.

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

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

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial