Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. cloudwatch
  6. getCompositeAlarm

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

Viewing docs for AWS Cloud Control v1.83.1
published on Thursday, Oct 22, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.cloudwatch.getCompositeAlarm

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.83.1
published on Thursday, Oct 22, 2026 by Pulumi
Schema (JSON)
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

    Using getCompositeAlarm

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCompositeAlarm(args: GetCompositeAlarmArgs, opts?: InvokeOptions): Promise<GetCompositeAlarmResult>
function getCompositeAlarmOutput(args: GetCompositeAlarmOutputArgs, opts?: InvokeOutputOptions): Output<GetCompositeAlarmResult>
    def get_composite_alarm(alarm_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetCompositeAlarmResult
def get_composite_alarm_output(alarm_name: pulumi.Input[Optional[str]] = None,
                        opts: Optional[InvokeOutputOptions] = None) -> Output[GetCompositeAlarmResult]
    func LookupCompositeAlarm(ctx *Context, args *LookupCompositeAlarmArgs, opts ...InvokeOption) (*LookupCompositeAlarmResult, error)
func LookupCompositeAlarmOutput(ctx *Context, args *LookupCompositeAlarmOutputArgs, opts ...InvokeOption) LookupCompositeAlarmResultOutput

    > Note: This function is named LookupCompositeAlarm in the Go SDK.

    public static class GetCompositeAlarm 
{
    public static Task<GetCompositeAlarmResult> InvokeAsync(GetCompositeAlarmArgs args, InvokeOptions? opts = null)
    public static Output<GetCompositeAlarmResult> Invoke(GetCompositeAlarmInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetCompositeAlarmResult> Invoke(GetCompositeAlarmInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetCompositeAlarmResult> getCompositeAlarm(GetCompositeAlarmArgs args, InvokeOptions options)
public static Output<GetCompositeAlarmResult> getCompositeAlarm(GetCompositeAlarmArgs args, InvokeOptions options)
public static Output<GetCompositeAlarmResult> getCompositeAlarm(GetCompositeAlarmArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:cloudwatch:getCompositeAlarm
  arguments:
    # arguments dictionary
    data "aws-native_cloudwatch_get_composite_alarm" "name" {
    # arguments
}

    The following arguments are supported:

    AlarmName string
    The name of the Composite Alarm
    AlarmName string
    The name of the Composite Alarm
    alarm_name string
    The name of the Composite Alarm
    alarmName String
    The name of the Composite Alarm
    alarmName string
    The name of the Composite Alarm
    alarm_name str
    The name of the Composite Alarm
    alarmName String
    The name of the Composite Alarm

    getCompositeAlarm Result

    The following output properties are available:

    ActionConfiguration Pulumi.AwsNative.CloudWatch.Outputs.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
    AlarmRule string
    Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
    Arn string
    Amazon Resource Name (ARN) 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).
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.
    ActionConfiguration 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 []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
    AlarmRule string
    Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
    Arn string
    Amazon Resource Name (ARN) 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).
    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.
    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_rule string
    Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
    arn string
    Amazon Resource Name (ARN) of the 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.
    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
    alarmRule String
    Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
    arn String
    Amazon Resource Name (ARN) 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).
    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.
    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
    alarmRule string
    Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
    arn string
    Amazon Resource Name (ARN) 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).
    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.
    action_configuration CompositeAlarmActionConfiguration
    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_rule str
    Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
    arn str
    Amazon Resource Name (ARN) 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).
    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[root_Tag]
    A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.
    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
    alarmRule String
    Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
    arn String
    Amazon Resource Name (ARN) 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).
    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.

    Supporting Types

    CompositeAlarmActionConfiguration

    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

    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

    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.83.1
    published on Thursday, Oct 22, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial