1. Packages
  2. AWS Native
  3. API Docs
  4. cloudwatch
  5. getCompositeAlarm

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.cloudwatch.getCompositeAlarm

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 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

    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?: InvokeOptions): Output<GetCompositeAlarmResult>
    def get_composite_alarm(alarm_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetCompositeAlarmResult
    def get_composite_alarm_output(alarm_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = 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 CompletableFuture<GetCompositeAlarmResult> getCompositeAlarm(GetCompositeAlarmArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:cloudwatch:getCompositeAlarm
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AlarmName string
    The name of the Composite Alarm
    AlarmName 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:

    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.
    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.
    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.
    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.
    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.
    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

    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 is in preview. AWS Classic is fully supported.

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi