CfnAlarm

class aws_cdk.aws_cloudwatch.CfnAlarm(scope, id, *, comparison_operator, evaluation_periods, actions_enabled=None, alarm_actions=None, alarm_description=None, alarm_name=None, datapoints_to_alarm=None, dimensions=None, evaluate_low_sample_count_percentile=None, extended_statistic=None, insufficient_data_actions=None, metric_name=None, metrics=None, namespace=None, ok_actions=None, period=None, statistic=None, threshold=None, threshold_metric_id=None, treat_missing_data=None, unit=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::CloudWatch::Alarm.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html

CloudformationResource

AWS::CloudWatch::Alarm

Create a new AWS::CloudWatch::Alarm.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • comparison_operator (str) – AWS::CloudWatch::Alarm.ComparisonOperator.

  • evaluation_periods (Union[int, float]) – AWS::CloudWatch::Alarm.EvaluationPeriods.

  • actions_enabled (Union[bool, IResolvable, None]) – AWS::CloudWatch::Alarm.ActionsEnabled.

  • alarm_actions (Optional[List[str]]) – AWS::CloudWatch::Alarm.AlarmActions.

  • alarm_description (Optional[str]) – AWS::CloudWatch::Alarm.AlarmDescription.

  • alarm_name (Optional[str]) – AWS::CloudWatch::Alarm.AlarmName.

  • datapoints_to_alarm (Union[int, float, None]) – AWS::CloudWatch::Alarm.DatapointsToAlarm.

  • dimensions (Union[IResolvable, List[Union[IResolvable, DimensionProperty]], None]) – AWS::CloudWatch::Alarm.Dimensions.

  • evaluate_low_sample_count_percentile (Optional[str]) – AWS::CloudWatch::Alarm.EvaluateLowSampleCountPercentile.

  • extended_statistic (Optional[str]) – AWS::CloudWatch::Alarm.ExtendedStatistic.

  • insufficient_data_actions (Optional[List[str]]) – AWS::CloudWatch::Alarm.InsufficientDataActions.

  • metric_name (Optional[str]) – AWS::CloudWatch::Alarm.MetricName.

  • metrics (Union[IResolvable, List[Union[IResolvable, MetricDataQueryProperty]], None]) – AWS::CloudWatch::Alarm.Metrics.

  • namespace (Optional[str]) – AWS::CloudWatch::Alarm.Namespace.

  • ok_actions (Optional[List[str]]) – AWS::CloudWatch::Alarm.OKActions.

  • period (Union[int, float, None]) – AWS::CloudWatch::Alarm.Period.

  • statistic (Optional[str]) – AWS::CloudWatch::Alarm.Statistic.

  • threshold (Union[int, float, None]) – AWS::CloudWatch::Alarm.Threshold.

  • threshold_metric_id (Optional[str]) – AWS::CloudWatch::Alarm.ThresholdMetricId.

  • treat_missing_data (Optional[str]) – AWS::CloudWatch::Alarm.TreatMissingData.

  • unit (Optional[str]) – AWS::CloudWatch::Alarm.Unit.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\." because the \ itself will need to be escaped.

For example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

inspect(inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::CloudWatch::Alarm'
actions_enabled

AWS::CloudWatch::Alarm.ActionsEnabled.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-actionsenabled

Return type

Union[bool, IResolvable, None]

alarm_actions

AWS::CloudWatch::Alarm.AlarmActions.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmactions

Return type

Optional[List[str]]

alarm_description

AWS::CloudWatch::Alarm.AlarmDescription.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmdescription

Return type

Optional[str]

alarm_name

AWS::CloudWatch::Alarm.AlarmName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmname

Return type

Optional[str]

attr_arn

Arn

Type

cloudformationAttribute

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

comparison_operator

AWS::CloudWatch::Alarm.ComparisonOperator.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-comparisonoperator

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

datapoints_to_alarm

AWS::CloudWatch::Alarm.DatapointsToAlarm.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarm-datapointstoalarm

Return type

Union[int, float, None]

dimensions

AWS::CloudWatch::Alarm.Dimensions.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-dimension

Return type

Union[IResolvable, List[Union[IResolvable, DimensionProperty]], None]

evaluate_low_sample_count_percentile

AWS::CloudWatch::Alarm.EvaluateLowSampleCountPercentile.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluatelowsamplecountpercentile

Return type

Optional[str]

evaluation_periods

AWS::CloudWatch::Alarm.EvaluationPeriods.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluationperiods

Return type

Union[int, float]

extended_statistic

AWS::CloudWatch::Alarm.ExtendedStatistic.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-extendedstatistic

Return type

Optional[str]

insufficient_data_actions

AWS::CloudWatch::Alarm.InsufficientDataActions.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-insufficientdataactions

Return type

Optional[List[str]]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

metric_name

AWS::CloudWatch::Alarm.MetricName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-metricname

Return type

Optional[str]

metrics

AWS::CloudWatch::Alarm.Metrics.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarm-metrics

Return type

Union[IResolvable, List[Union[IResolvable, MetricDataQueryProperty]], None]

namespace

AWS::CloudWatch::Alarm.Namespace.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-namespace

Return type

Optional[str]

node

The construct tree node associated with this construct.

Return type

ConstructNode

ok_actions

AWS::CloudWatch::Alarm.OKActions.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-okactions

Return type

Optional[List[str]]

period

AWS::CloudWatch::Alarm.Period.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-period

Return type

Union[int, float, None]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

statistic

AWS::CloudWatch::Alarm.Statistic.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-statistic

Return type

Optional[str]

threshold

AWS::CloudWatch::Alarm.Threshold.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-threshold

Return type

Union[int, float, None]

threshold_metric_id

AWS::CloudWatch::Alarm.ThresholdMetricId.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-dynamic-threshold

Return type

Optional[str]

treat_missing_data

AWS::CloudWatch::Alarm.TreatMissingData.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-treatmissingdata

Return type

Optional[str]

unit

AWS::CloudWatch::Alarm.Unit.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-unit

Return type

Optional[str]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

DimensionProperty

class CfnAlarm.DimensionProperty(*, name, value)

Bases: object

Parameters
  • name (str) – CfnAlarm.DimensionProperty.Name.

  • value (str) – CfnAlarm.DimensionProperty.Value.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html

Attributes

name

CfnAlarm.DimensionProperty.Name.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html#cfn-cloudwatch-alarm-dimension-name

Return type

str

value

CfnAlarm.DimensionProperty.Value.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html#cfn-cloudwatch-alarm-dimension-value

Return type

str

MetricDataQueryProperty

class CfnAlarm.MetricDataQueryProperty(*, id, expression=None, label=None, metric_stat=None, period=None, return_data=None)

Bases: object

Parameters
  • id (str) – CfnAlarm.MetricDataQueryProperty.Id.

  • expression (Optional[str]) – CfnAlarm.MetricDataQueryProperty.Expression.

  • label (Optional[str]) – CfnAlarm.MetricDataQueryProperty.Label.

  • metric_stat (Union[IResolvable, MetricStatProperty, None]) – CfnAlarm.MetricDataQueryProperty.MetricStat.

  • period (Union[int, float, None]) – CfnAlarm.MetricDataQueryProperty.Period.

  • return_data (Union[bool, IResolvable, None]) – CfnAlarm.MetricDataQueryProperty.ReturnData.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html

Attributes

expression

CfnAlarm.MetricDataQueryProperty.Expression.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-expression

Return type

Optional[str]

id

CfnAlarm.MetricDataQueryProperty.Id.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-id

Return type

str

label

CfnAlarm.MetricDataQueryProperty.Label.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-label

Return type

Optional[str]

metric_stat

CfnAlarm.MetricDataQueryProperty.MetricStat.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-metricstat

Return type

Union[IResolvable, MetricStatProperty, None]

period

CfnAlarm.MetricDataQueryProperty.Period.

Return type

Union[int, float, None]

return_data

CfnAlarm.MetricDataQueryProperty.ReturnData.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html#cfn-cloudwatch-alarm-metricdataquery-returndata

Return type

Union[bool, IResolvable, None]

MetricProperty

class CfnAlarm.MetricProperty(*, dimensions=None, metric_name=None, namespace=None)

Bases: object

Parameters
  • dimensions (Union[IResolvable, List[Union[IResolvable, DimensionProperty]], None]) – CfnAlarm.MetricProperty.Dimensions.

  • metric_name (Optional[str]) – CfnAlarm.MetricProperty.MetricName.

  • namespace (Optional[str]) – CfnAlarm.MetricProperty.Namespace.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html

Attributes

dimensions

CfnAlarm.MetricProperty.Dimensions.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html#cfn-cloudwatch-alarm-metric-dimensions

Return type

Union[IResolvable, List[Union[IResolvable, DimensionProperty]], None]

metric_name

CfnAlarm.MetricProperty.MetricName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html#cfn-cloudwatch-alarm-metric-metricname

Return type

Optional[str]

namespace

CfnAlarm.MetricProperty.Namespace.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html#cfn-cloudwatch-alarm-metric-namespace

Return type

Optional[str]

MetricStatProperty

class CfnAlarm.MetricStatProperty(*, metric, period, stat, unit=None)

Bases: object

Parameters
  • metric (Union[IResolvable, MetricProperty]) – CfnAlarm.MetricStatProperty.Metric.

  • period (Union[int, float]) – CfnAlarm.MetricStatProperty.Period.

  • stat (str) – CfnAlarm.MetricStatProperty.Stat.

  • unit (Optional[str]) – CfnAlarm.MetricStatProperty.Unit.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html

Attributes

metric

CfnAlarm.MetricStatProperty.Metric.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-metric

Return type

Union[IResolvable, MetricProperty]

period

CfnAlarm.MetricStatProperty.Period.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-period

Return type

Union[int, float]

stat

CfnAlarm.MetricStatProperty.Stat.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-stat

Return type

str

unit

CfnAlarm.MetricStatProperty.Unit.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html#cfn-cloudwatch-alarm-metricstat-unit

Return type

Optional[str]