@aws-cdk/aws-cloudwatch

constructor

constructor(scope: Construct, id: string, props: AlarmProps);

property alarmArn

readonly alarmArn: string;

• ARN of this alarm

property alarmName

readonly alarmName: string;

• Name of this alarm.

property metric

readonly metric: IMetric;

• The metric object this alarm was based on

method addAlarmAction

addAlarmAction: (...actions: IAlarmAction[]) => void;

• Trigger this action if the alarm fires

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

method fromAlarmArn

static fromAlarmArn: (scope: Construct, id: string, alarmArn: string) => IAlarm;

• Import an existing CloudWatch alarm provided an ARN

  Parameter scope

  The parent creating construct (usually this).

  Parameter id

  The construct's name

  Parameter alarmArn

  Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo)

method toAnnotation

toAnnotation: () => HorizontalAnnotation;

• Turn this alarm into a horizontal annotation

  This is useful if you want to represent an Alarm in a non-AlarmWidget. An AlarmWidget can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph.

  This might be useful if:

  - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm.

  - You want to show an Alarm line in a graph with multiple metrics in it.

property alarmActionArns

protected alarmActionArns?: string[];

property alarmArn

abstract readonly alarmArn: string;

property alarmName

abstract readonly alarmName: string;

property insufficientDataActionArns

protected insufficientDataActionArns?: string[];

property okActionArns

protected okActionArns?: string[];

method addAlarmAction

addAlarmAction: (...actions: IAlarmAction[]) => void;

• Trigger this action if the alarm fires

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

method addInsufficientDataAction

addInsufficientDataAction: (...actions: IAlarmAction[]) => void;

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

method addOkAction

addOkAction: (...actions: IAlarmAction[]) => void;

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

method renderAlarmRule

renderAlarmRule: () => string;

• AlarmRule indicating ALARM state for Alarm.

method allOf

static allOf: (...operands: IAlarmRule[]) => IAlarmRule;

• function to join all provided AlarmRules with AND operator.

  Parameter operands

  IAlarmRules to be joined with AND operator.

method anyOf

static anyOf: (...operands: IAlarmRule[]) => IAlarmRule;

• function to join all provided AlarmRules with OR operator.

  Parameter operands

  IAlarmRules to be joined with OR operator.

method fromAlarm

static fromAlarm: (alarm: IAlarm, alarmState: AlarmState) => IAlarmRule;

• function to build Rule Expression for given IAlarm and AlarmState.

  Parameter alarm

  IAlarm to be used in Rule Expression.

  Parameter alarmState

  AlarmState to be used in Rule Expression.

method fromBoolean

static fromBoolean: (value: boolean) => IAlarmRule;

• function to build TRUE/FALSE intent for Rule Expression.

  Parameter value

  boolean value to be used in rule expression.

method fromString

static fromString: (alarmRule: string) => IAlarmRule;

• function to build Rule Expression for given Alarm Rule string.

  Parameter alarmRule

  string to be used in Rule Expression.

method not

static not: (operand: IAlarmRule) => IAlarmRule;

• function to wrap provided AlarmRule in NOT operator.

  Parameter operand

  IAlarmRule to be wrapped in NOT operator.

constructor

constructor(props: AlarmStatusWidgetProps);

method position

position: (x: number, y: number) => void;

method toJson

toJson: () => any[];

constructor

constructor(props: AlarmWidgetProps);

method toJson

toJson: () => any[];

constructor

constructor(scope: cdk.Construct, id: string, props: CfnAlarmProps);

• Create a new AWS::CloudWatch::Alarm.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property actionsEnabled

actionsEnabled: any;

• Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

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

property alarmActions

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). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *Amazon CloudWatch API Reference* .

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

property alarmDescription

alarmDescription: string;

• The description of the alarm.

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

property alarmName

alarmName: string;

• The name of the alarm. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the alarm name.

  > If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

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

property attrArn

readonly attrArn: string;

• The ARN of the CloudWatch alarm, such as arn:aws:cloudwatch:us-west-2:123456789012:alarm:myCloudWatchAlarm-CPUAlarm-UXMMZK36R55Z . Arn

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property comparisonOperator

comparisonOperator: string;

• The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

  You can specify the following values: GreaterThanThreshold , GreaterThanOrEqualToThreshold , LessThanThreshold , or LessThanOrEqualToThreshold .

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

property datapointsToAlarm

datapointsToAlarm: number;

• The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for EvaluationPeriods is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *Amazon CloudWatch User Guide* .

  If you omit this parameter, CloudWatch uses the same value here that you set for EvaluationPeriods , and the alarm goes to alarm state if that many consecutive periods are breaching.

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

property dimensions

dimensions: any;

• The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions . Instead, you use Metrics .

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

property evaluateLowSampleCountPercentile

evaluateLowSampleCountPercentile: string;

• Used only for alarms based on percentiles. If ignore , the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

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

property evaluationPeriods

evaluationPeriods: number;

• The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and DatapointsToAlarm is the M.

  For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *Amazon CloudWatch User Guide* .

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

property extendedStatistic

extendedStatistic: string;

• The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

  For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.

  For an alarm based on a math expression, you can't specify ExtendedStatistic . Instead, you use Metrics .

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

property insufficientDataActions

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

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

property metricName

metricName: string;

• The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName .

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

property metrics

metrics: any;

• An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.

  If you specify the Metrics parameter, you cannot specify MetricName , Dimensions , Period , Namespace , Statistic , ExtendedStatistic , or Unit .

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

property namespace

namespace: string;

• The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead.

  For a list of namespaces for metrics from AWS services, see [AWS Services That Publish CloudWatch Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)

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

property okActions

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

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

property period

period: number;

• The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.

  For an alarm based on a math expression, you can't specify Period , and instead you use the Metrics parameter.

  *Minimum:* 10

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

property statistic

statistic: string;

• The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic .

  For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.

  For an alarm based on a math expression, you can't specify Statistic . Instead, you use Metrics .

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

property threshold

threshold: number;

• The value to compare with the specified statistic.

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

property thresholdMetricId

thresholdMetricId: string;

• In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.

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

property treatMissingData

treatMissingData: string;

• Sets how this alarm is to handle missing data points. Valid values are breaching , notBreaching , ignore , and missing . For more information, see [Configuring How CloudWatch Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon CloudWatch User Guide* .

  If you omit this parameter, the default behavior of missing is used.

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

property unit

unit: string;

• The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a Metrics array.

  You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.

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

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props?: CfnAnomalyDetectorProps);

• Create a new AWS::CloudWatch::AnomalyDetector.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property configuration

configuration: any;

• Specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model. The configuration can also include the time zone to use for the metric.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-configuration

property dimensions

dimensions: any;

• The dimensions of the metric associated with the anomaly detection band.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-dimensions

property metricMathAnomalyDetector

metricMathAnomalyDetector: any;

• The CloudWatch metric math expression for this anomaly detector.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-metricmathanomalydetector

property metricName

metricName: string;

• The name of the metric associated with the anomaly detection band.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-metricname

property namespace

namespace: string;

• The namespace of the metric associated with the anomaly detection band.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-namespace

property singleMetricAnomalyDetector

singleMetricAnomalyDetector: any;

• The CloudWatch metric and statistic for this anomaly detector.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-singlemetricanomalydetector

property stat

stat: string;

• The statistic of the metric associated with the anomaly detection band.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html#cfn-cloudwatch-anomalydetector-stat

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnCompositeAlarmProps);

• Create a new AWS::CloudWatch::CompositeAlarm.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property actionsEnabled

actionsEnabled: any;

• Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is TRUE.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionsenabled

property actionsSuppressor

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.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionssuppressor

property actionsSuppressorExtensionPeriod

actionsSuppressorExtensionPeriod: number;

• The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM state. After this time, the composite alarm performs its actions.

  > ExtensionPeriod is required only when ActionsSuppressor is specified.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionssuppressorextensionperiod

property actionsSuppressorWaitPeriod

actionsSuppressorWaitPeriod: number;

• The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM state. After this time, the composite alarm performs its actions.

  > WaitPeriod is required only when ActionsSuppressor is specified.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-actionssuppressorwaitperiod

property alarmActions

alarmActions: string[];

• The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmactions

property alarmDescription

alarmDescription: string;

• The description for the composite alarm.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmdescription

property alarmName

alarmName: string;

• The name for the composite alarm. This name must be unique within your AWS account.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmname

property alarmRule

alarmRule: string;

• An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state. For each alarm that you reference, you designate a function that specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the functions in your expression.

  You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.

  Functions can include the following:

  - ALARM("alarm-name or alarm-ARN") is TRUE if the named alarm is in ALARM state. - OK("alarm-name or alarm-ARN") is TRUE if the named alarm is in OK state. - INSUFFICIENT_DATA("alarm-name or alarm-ARN") is TRUE if the named alarm is in INSUFFICIENT_DATA state. - TRUE always evaluates to TRUE. - FALSE always evaluates to FALSE.

  TRUE and FALSE are useful for testing a complex AlarmRule structure, and for testing your alarm actions.

  For more information about AlarmRule syntax, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-alarmrule

property attrArn

readonly attrArn: string;

• The ARN of the composite alarm, such as arn:aws:cloudwatch:us-west-2:123456789012:alarm/CompositeAlarmName . Arn

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property insufficientDataActions

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). For more information about creating alarms and the actions that you can specify, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-insufficientdataactions

property okActions

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). For more information about creating alarms and the actions that you can specify, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html#cfn-cloudwatch-compositealarm-okactions

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnDashboardProps);

• Create a new AWS::CloudWatch::Dashboard.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property dashboardBody

dashboardBody: string;

• The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required.

  For more information about the syntax, see [Dashboard Body Structure and Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html#cfn-cloudwatch-dashboard-dashboardbody

property dashboardName

dashboardName: string;

• The name of the dashboard. The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html#cfn-cloudwatch-dashboard-dashboardname

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnInsightRuleProps);

• Create a new AWS::CloudWatch::InsightRule.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrArn

readonly attrArn: string;

• The ARN of the Contributor Insights rule, such as arn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName . Arn

property attrRuleName

readonly attrRuleName: string;

• The name of the Contributor Insights rule. RuleName

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property ruleBody

ruleBody: string;

• The definition of the rule, as a JSON object. For details about the syntax, see [Contributor Insights Rule Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html) in the *Amazon CloudWatch User Guide* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulebody

property ruleName

ruleName: string;

• The name of the rule.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulename

property ruleState

ruleState: string;

• The current state of the rule. Valid values are ENABLED and DISABLED .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulestate

property tags

readonly tags: cdk.TagManager;

• A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.

  Tags can help you organize and categorize your resources. For more information, see [Tagging Your Amazon CloudWatch Resources](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Tagging.html) .

  To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnMetricStreamProps);

• Create a new AWS::CloudWatch::MetricStream.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrArn

readonly attrArn: string;

• The ARN of the metric stream. Arn

property attrCreationDate

readonly attrCreationDate: string;

• The date that the metric stream was originally created. CreationDate

property attrLastUpdateDate

readonly attrLastUpdateDate: string;

• The date that the metric stream was most recently updated. LastUpdateDate

property attrState

readonly attrState: string;

• The state of the metric stream, either running or stopped . State

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property excludeFilters

excludeFilters: any;

• If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here. You cannot specify both IncludeFilters and ExcludeFilters in the same metric stream.

  When you modify the IncludeFilters or ExcludeFilters of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-excludefilters

property firehoseArn

firehoseArn: string;

• The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream. This Amazon Kinesis Firehose delivery stream must already exist and must be in the same account as the metric stream.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-firehosearn

property includeFilters

includeFilters: any;

• If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here. You cannot specify both IncludeFilters and ExcludeFilters in the same metric stream.

  When you modify the IncludeFilters or ExcludeFilters of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-includefilters

property includeLinkedAccountsMetrics

includeLinkedAccountsMetrics: any;

• If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false .

  For more information about linking accounts, see [CloudWatch cross-account observability](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html)

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-includelinkedaccountsmetrics

property name

name: string;

• If you are creating a new metric stream, this is the name for the new stream. The name must be different than the names of other metric streams in this account and Region.

  If you are updating a metric stream, specify the name of that stream here.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-name

property outputFormat

outputFormat: string;

• The output format for the stream. Valid values are json and opentelemetry0.7 For more information about metric stream output formats, see [Metric streams output formats](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html) .

  This parameter is required.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-outputformat

property roleArn

roleArn: string;

• The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the firehose:PutRecord and firehose:PutRecordBatch permissions.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-rolearn

property statisticsConfigurations

statisticsConfigurations: any;

• By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.

  For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream's OutputFormat . If the OutputFormat is json , you can stream any additional statistic that is supported by CloudWatch , listed in [CloudWatch statistics definitions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html) . If the OutputFormat is opentelemetry0 .7, you can stream percentile statistics *(p??)* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-statisticsconfigurations

property tags

readonly tags: cdk.TagManager;

• An array of key-value pairs to apply to the metric stream.

  For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

property BLUE

static readonly BLUE: string;

• blue - hex #1f77b4

property BROWN

static readonly BROWN: string;

• brown - hex #8c564b

property GREEN

static readonly GREEN: string;

• green - hex #2ca02c

property GREY

static readonly GREY: string;

• grey - hex #7f7f7f

property ORANGE

static readonly ORANGE: string;

• orange - hex #ff7f0e

property PINK

static readonly PINK: string;

• pink - hex #e377c2

property PURPLE

static readonly PURPLE: string;

• purple - hex #9467bd

property RED

static readonly RED: string;

• red - hex #d62728

constructor

constructor(...widgets: IWidget[]);

property height

readonly height: number;

property widgets

readonly widgets: IWidget[];

• List of contained widgets

property width

readonly width: number;

method position

position: (x: number, y: number) => void;

method toJson

toJson: () => any[];

constructor

constructor(scope: Construct, id: string, props: CompositeAlarmProps);

property alarmArn

readonly alarmArn: string;

• ARN of this alarm

property alarmName

readonly alarmName: string;

• Name of this alarm.

method fromCompositeAlarmArn

static fromCompositeAlarmArn: (
    scope: Construct,
    id: string,
    compositeAlarmArn: string
) => IAlarm;

• Import an existing CloudWatch composite alarm provided an ARN.

  Parameter scope

  The parent creating construct (usually this)

  Parameter id

  The construct's name

  Parameter compositeAlarmArn

  Composite Alarm ARN (i.e. arn:aws:cloudwatch:::alarm/CompositeAlarmName)

method fromCompositeAlarmName

static fromCompositeAlarmName: (
    scope: Construct,
    id: string,
    compositeAlarmName: string
) => IAlarm;

• Import an existing CloudWatch composite alarm provided an Name.

  Parameter scope

  The parent creating construct (usually this)

  Parameter id

  The construct's name

  Parameter compositeAlarmName

  Composite Alarm Name

constructor

constructor(width: number, height: number);

property height

readonly height: number;

property warnings

readonly warnings: string[];

property width

readonly width: number;

property x

protected x?: number;

property y

protected y?: number;

method copyMetricWarnings

protected copyMetricWarnings: (...ms: IMetric[]) => void;

• Copy the warnings from the given metric

method position

position: (x: number, y: number) => void;

method toJson

abstract toJson: () => any[];

constructor

constructor(props: CustomWidgetProps);

method toJson

toJson: () => any[];

constructor

constructor(scope: Construct, id: string, props?: DashboardProps);

property dashboardArn

readonly dashboardArn: string;

• ARN of this dashboard

property dashboardName

readonly dashboardName: string;

• The name of this dashboard

method addWidgets

addWidgets: (...widgets: IWidget[]) => void;

• Add a widget to the dashboard.

  Widgets given in multiple calls to add() will be laid out stacked on top of each other.

  Multiple widgets added in the same call to add() will be laid out next to each other.

constructor

constructor(props: GraphWidgetProps);

method addLeftMetric

addLeftMetric: (metric: IMetric) => void;

• Add another metric to the left Y axis of the GraphWidget

  Parameter metric

  the metric to add

method addRightMetric

addRightMetric: (metric: IMetric) => void;

• Add another metric to the right Y axis of the GraphWidget

  Parameter metric

  the metric to add

method toJson

toJson: () => any[];

constructor

constructor(props: LogQueryWidgetProps);

method toJson

toJson: () => any[];

constructor

constructor(props: MathExpressionProps);

property color

readonly color?: string;

• The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here.

property expression

readonly expression: string;

• The expression defining the metric.

property label

readonly label?: string;

• Label for this metric when added to a Graph.

property period

readonly period: cdk.Duration;

• Aggregation period of this metric

property searchAccount

readonly searchAccount?: string;

• Account to evaluate search expressions within.

property searchRegion

readonly searchRegion?: string;

• Region to evaluate search expressions within.

property usingMetrics

readonly usingMetrics: Record<string, IMetric>;

• The metrics used in the expression as KeyValuePair <id, metric>.

property warnings

readonly warnings?: string[];

• Warnings generated by this math expression

method createAlarm

createAlarm: (scope: Construct, id: string, props: CreateAlarmOptions) => Alarm;

• Make a new Alarm for this metric

  Combines both properties that may adjust the metric (aggregation) as well as alarm properties.

method toAlarmConfig

toAlarmConfig: () => MetricAlarmConfig;

• Deprecated

  use toMetricConfig()

method toGraphConfig

toGraphConfig: () => MetricGraphConfig;

• Deprecated

  use toMetricConfig()

method toMetricConfig

toMetricConfig: () => MetricConfig;

method toString

toString: () => string;

method with

with: (props: MathExpressionOptions) => MathExpression;

• Return a copy of Metric with properties changed.

  All properties except namespace and metricName can be changed.

  Parameter props

  The set of properties to change.

constructor

constructor(props: MetricProps);

property account

readonly account?: string;

• Account which this metric comes from

property color

readonly color?: string;

• The hex color code used when this metric is rendered on a graph.

property dimensions

readonly dimensions?: DimensionHash;

• Dimensions of this metric

property label

readonly label?: string;

• Label for this metric when added to a Graph in a Dashboard

property metricName

readonly metricName: string;

• Name of this metric

property namespace

readonly namespace: string;

• Namespace of this metric

property period

readonly period: cdk.Duration;

• Period of this metric

property region

readonly region?: string;

• Region which this metric comes from.

property statistic

readonly statistic: string;

• Statistic of this metric

property unit

readonly unit?: Unit;

• Unit of the metric.

property warnings

readonly warnings?: string[];

• Warnings attached to this metric.

method attachTo

attachTo: (scope: constructs.IConstruct) => Metric;

• Attach the metric object to the given construct scope

  Returns a Metric object that uses the account and region from the Stack the given construct is defined in. If the metric is subsequently used in a Dashboard or Alarm in a different Stack defined in a different account or region, the appropriate 'region' and 'account' fields will be added to it.

  If the scope we attach to is in an environment-agnostic stack, nothing is done and the same Metric object is returned.

method createAlarm

createAlarm: (scope: Construct, id: string, props: CreateAlarmOptions) => Alarm;

• Make a new Alarm for this metric

  Combines both properties that may adjust the metric (aggregation) as well as alarm properties.

method grantPutMetricData

static grantPutMetricData: (grantee: iam.IGrantable) => iam.Grant;

• Grant permissions to the given identity to write metrics.

  Parameter grantee

  The IAM identity to give permissions to.

method toAlarmConfig

toAlarmConfig: () => MetricAlarmConfig;

• Deprecated

  use toMetricConfig()

method toGraphConfig

toGraphConfig: () => MetricGraphConfig;

• Deprecated

  use toMetricConfig()

method toMetricConfig

toMetricConfig: () => MetricConfig;

method toString

toString: () => string;

method with

with: (props: MetricOptions) => Metric;

• Return a copy of Metric with properties changed.

  All properties except namespace and metricName can be changed.

  Parameter props

  The set of properties to change.

constructor

constructor(...widgets: IWidget[]);

property height

readonly height: number;

property widgets

readonly widgets: IWidget[];

• List of contained widgets

property width

readonly width: number;

method position

position: (x: number, y: number) => void;

method toJson

toJson: () => any[];

constructor

constructor(props: SingleValueWidgetProps);

method toJson

toJson: () => any[];

constructor

constructor(props?: SpacerProps);

property height

readonly height: number;

property width