AlarmBase

class aws_cdk.aws_cloudwatch.AlarmBase(scope, id, *, physical_name=None)

Bases: aws_cdk.core.Resource

The base class for Alarm and CompositeAlarm resources.

__init__(scope, id, *, physical_name=None)
Parameters
  • scope (Construct) –

  • id (str) –

  • physical_name (Optional[str]) – The value passed in by users to the physical name prop of the resource. - undefined implies that a physical name will be allocated by CloudFormation during deployment. - a concrete value implies a specific physical name - PhysicalName.GENERATE_IF_NEEDED is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation. Default: - The physical name will be allocated by CloudFormation at deployment time

Return type

None

Methods

add_alarm_action(*actions)

Trigger this action if the alarm fires.

Typically the ARN of an SNS topic or ARN of an AutoScaling policy.

Parameters

actions (IAlarmAction) –

Return type

None

add_insufficient_data_action(*actions)

Trigger this action if there is insufficient data to evaluate the alarm.

Typically the ARN of an SNS topic or ARN of an AutoScaling policy.

Parameters

actions (IAlarmAction) –

Return type

None

add_ok_action(*actions)

Trigger this action if the alarm returns from breaching state into ok state.

Typically the ARN of an SNS topic or ARN of an AutoScaling policy.

Parameters

actions (IAlarmAction) –

Return type

None

render_alarm_rule()

AlarmRule indicating ALARM state for Alarm.

Return type

str

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

alarm_arn

cloudwatch:::alarm:Foo).

attribute: :attribute:: true

Type

Alarm ARN (i.e. arn

Type

aws

Return type

str

alarm_name

Name of the alarm.

Return type

str

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool