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

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

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.cloudwatch.CompositeAlarm

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.103.0 published on Monday, Apr 22, 2024 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 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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const compositeAlarmResource = new aws_native.cloudwatch.CompositeAlarm("compositeAlarmResource", {
    alarmRule: "string",
    actionsEnabled: false,
    actionsSuppressor: "string",
    actionsSuppressorExtensionPeriod: 0,
    actionsSuppressorWaitPeriod: 0,
    alarmActions: ["string"],
    alarmDescription: "string",
    alarmName: "string",
    insufficientDataActions: ["string"],
    okActions: ["string"],
    tags: [{
        key: "string",
        value: "string",
    }],
});

    Coming soon!

    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

    The CompositeAlarm resource accepts the following input properties:

    AlarmRule 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 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 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 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 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 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 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.103.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-aws-native