@aws-cdk/aws-cloudwatch

  • Version 1.157.0
  • Published
  • 1.97 MB
  • 3 dependencies
  • Apache-2.0 license

Install

npm i @aws-cdk/aws-cloudwatch
yarn add @aws-cdk/aws-cloudwatch
pnpm add @aws-cdk/aws-cloudwatch

Overview

The CDK Construct Library for AWS::CloudWatch

Index

Variables

Classes

Interfaces

Enums

Type Aliases

Namespaces

Variables

variable GRID_WIDTH

const GRID_WIDTH: number;
  • The width of the grid we're filling

Classes

class Alarm

class Alarm extends AlarmBase {}
  • An alarm on a CloudWatch metric

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.

    class AlarmBase

    abstract class AlarmBase extends Resource implements IAlarm {}
    • The base class for Alarm and CompositeAlarm resources.

    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.

            class AlarmRule

            class AlarmRule {}
            • Class with static functions to build AlarmRule for Composite Alarms.

            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.

            class AlarmStatusWidget

            class AlarmStatusWidget extends ConcreteWidget {}
            • A dashboard widget that displays alarms in a grid view

            constructor

            constructor(props: AlarmStatusWidgetProps);

              method position

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

                method toJson

                toJson: () => any[];

                  class AlarmWidget

                  class AlarmWidget extends ConcreteWidget {}
                  • Display the metric associated with an alarm, including the alarm line

                  constructor

                  constructor(props: AlarmWidgetProps);

                    method toJson

                    toJson: () => any[];

                      class CfnAlarm

                      class CfnAlarm extends cdk.CfnResource implements cdk.IInspectable {}
                      • A CloudFormation AWS::CloudWatch::Alarm

                        The AWS::CloudWatch::Alarm type specifies an alarm and associates it with the specified metric or metric math expression.

                        When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA . The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

                        When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

                        AWS::CloudWatch::Alarm external

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

                      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-properties-cw-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-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmactions

                      property alarmDescription

                      alarmDescription: string;
                      • The description of the alarm.

                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-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-properties-cw-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-properties-cw-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-properties-cw-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-properties-cw-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-properties-cw-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-properties-cw-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-properties-cw-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-properties-cw-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-properties-cw-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-properties-cw-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-properties-cw-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-properties-cw-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-properties-cw-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-properties-cw-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-properties-cw-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-properties-cw-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-properties-cw-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-properties-cw-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;
                        };

                          class CfnAnomalyDetector

                          class CfnAnomalyDetector extends cdk.CfnResource implements cdk.IInspectable {}
                          • A CloudFormation AWS::CloudWatch::AnomalyDetector

                            The AWS::CloudWatch::AnomalyDetector type specifies an anomaly detection band for a certain metric and statistic. The band represents the expected "normal" range for the metric values. Anomaly detection bands can be used for visualization of a metric's expected values, and for alarms.

                            AWS::CloudWatch::AnomalyDetector external

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

                          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;
                            };

                              class CfnCompositeAlarm

                              class CfnCompositeAlarm extends cdk.CfnResource implements cdk.IInspectable {}
                              • A CloudFormation AWS::CloudWatch::CompositeAlarm

                                The AWS::CloudWatch::CompositeAlarm type creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.

                                The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.

                                Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.

                                Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.

                                When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.

                                When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

                                AWS::CloudWatch::CompositeAlarm external

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

                              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 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;
                                };

                                  class CfnDashboard

                                  class CfnDashboard extends cdk.CfnResource implements cdk.IInspectable {}
                                  • A CloudFormation AWS::CloudWatch::Dashboard

                                    The AWS::CloudWatch::Dashboard resource specifies an Amazon CloudWatch dashboard. A dashboard is a customizable home page in the CloudWatch console that you can use to monitor your AWS resources in a single view.

                                    All dashboards in your account are global, not region-specific.

                                    AWS::CloudWatch::Dashboard external

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

                                  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;
                                    };

                                      class CfnInsightRule

                                      class CfnInsightRule extends cdk.CfnResource implements cdk.IInspectable {}
                                      • A CloudFormation AWS::CloudWatch::InsightRule

                                        Creates or updates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see [Using Contributor Insights to Analyze High-Cardinality Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html) in the *Amazon CloudWatch User Guide* .

                                        AWS::CloudWatch::InsightRule external

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

                                      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;
                                        };

                                          class CfnMetricStream

                                          class CfnMetricStream extends cdk.CfnResource implements cdk.IInspectable {}
                                          • A CloudFormation AWS::CloudWatch::MetricStream

                                            Creates or updates a metric stream. Metrics streams can automatically stream CloudWatch metrics to AWS destinations including Amazon S3 and to many third-party solutions. For more information, see [Metric streams](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html) .

                                            To create a metric stream, you must be logged on to an account that has the iam:PassRole permission and either the *CloudWatchFullAccess* policy or the cloudwatch:PutMetricStream permission.

                                            When you create or update a metric stream, you choose one of the following:

                                            - Stream metrics from all metric namespaces in the account. - Stream metrics from all metric namespaces in the account, except for the namespaces that you list in ExcludeFilters . - Stream metrics from only the metric namespaces that you list in IncludeFilters .

                                            When you create a metric stream, the stream is created in the running state. If you update an existing metric stream, the state does not change.

                                            AWS::CloudWatch::MetricStream external

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

                                          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 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;
                                            };

                                              class Color

                                              class Color {}
                                              • A set of standard colours that can be used in annotations in a GraphWidget.

                                              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

                                              class Column

                                              class Column implements IWidget {}
                                              • A widget that contains other widgets in a vertical column

                                                Widgets will be laid out next to each other

                                              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[];

                                                        class CompositeAlarm

                                                        class CompositeAlarm extends AlarmBase {}
                                                        • A Composite Alarm based on Alarm Rule.

                                                        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

                                                          class ConcreteWidget

                                                          abstract class ConcreteWidget implements IWidget {}
                                                          • A real CloudWatch widget that has its own fixed size and remembers its position

                                                            This is in contrast to other widgets which exist for layout purposes.

                                                          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[];

                                                                          class CustomWidget

                                                                          class CustomWidget extends ConcreteWidget {}
                                                                          • A CustomWidget shows the result of a AWS lambda function

                                                                          constructor

                                                                          constructor(props: CustomWidgetProps);

                                                                            method toJson

                                                                            toJson: () => any[];

                                                                              class Dashboard

                                                                              class Dashboard extends Resource {}
                                                                              • A CloudWatch dashboard

                                                                              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.

                                                                                class GraphWidget

                                                                                class GraphWidget extends ConcreteWidget {}
                                                                                • A dashboard widget that displays metrics

                                                                                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[];

                                                                                    class LogQueryWidget

                                                                                    class LogQueryWidget extends ConcreteWidget {}
                                                                                    • Display query results from Logs Insights

                                                                                    constructor

                                                                                    constructor(props: LogQueryWidgetProps);

                                                                                      method toJson

                                                                                      toJson: () => any[];

                                                                                        class MathExpression

                                                                                        class MathExpression implements IMetric {}
                                                                                        • A math expression built with metric(s) emitted by a service

                                                                                          The math expression is a combination of an expression (x+y) and metrics to apply expression on. It also contains metadata which is used only in graphs, such as color and label. It makes sense to embed this in here, so that compound constructs can attach that metadata to metrics they expose.

                                                                                          MathExpression can also be used for search expressions. In this case, it also optionally accepts a searchRegion and searchAccount property for cross-environment search expressions.

                                                                                          This class does not represent a resource, so hence is not a construct. Instead, MathExpression is an abstraction that makes it easy to specify metrics for use in both alarms and graphs.

                                                                                        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.

                                                                                              class Metric

                                                                                              class Metric implements IMetric {}
                                                                                              • A metric emitted by a service

                                                                                                The metric is a combination of a metric identifier (namespace, name and dimensions) and an aggregation function (statistic, period and unit).

                                                                                                It also contains metadata which is used only in graphs, such as color and label. It makes sense to embed this in here, so that compound constructs can attach that metadata to metrics they expose.

                                                                                                This class does not represent a resource, so hence is not a construct. Instead, Metric is an abstraction that makes it easy to specify metrics for use in both alarms and graphs.

                                                                                              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.

                                                                                                    class Row

                                                                                                    class Row implements IWidget {}
                                                                                                    • A widget that contains other widgets in a horizontal row

                                                                                                      Widgets will be laid out next to each other

                                                                                                    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[];

                                                                                                              class SingleValueWidget

                                                                                                              class SingleValueWidget extends ConcreteWidget {}
                                                                                                              • A dashboard widget that displays the most recent value for every metric

                                                                                                              constructor

                                                                                                              constructor(props: SingleValueWidgetProps);

                                                                                                                method toJson

                                                                                                                toJson: () => any[];

                                                                                                                  class Spacer

                                                                                                                  class Spacer implements IWidget {}
                                                                                                                  • A widget that doesn't display anything but takes up space

                                                                                                                  constructor

                                                                                                                  constructor(props?: SpacerProps);

                                                                                                                    property height

                                                                                                                    readonly height: number;

                                                                                                                      property width

                                                                                                                      readonly width: number;

                                                                                                                        method position

                                                                                                                        position: (_x: number, _y: number) => void;

                                                                                                                          method toJson

                                                                                                                          toJson: () => any[];

                                                                                                                            class TextWidget

                                                                                                                            class TextWidget extends ConcreteWidget {}
                                                                                                                            • A dashboard widget that displays MarkDown

                                                                                                                            constructor

                                                                                                                            constructor(props: TextWidgetProps);

                                                                                                                              method position

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

                                                                                                                                method toJson

                                                                                                                                toJson: () => any[];

                                                                                                                                  Interfaces

                                                                                                                                  interface AlarmActionConfig

                                                                                                                                  interface AlarmActionConfig {}
                                                                                                                                  • Properties for an alarm action

                                                                                                                                  property alarmActionArn

                                                                                                                                  readonly alarmActionArn: string;
                                                                                                                                  • Return the ARN that should be used for a CloudWatch Alarm action

                                                                                                                                  interface AlarmProps

                                                                                                                                  interface AlarmProps extends CreateAlarmOptions {}
                                                                                                                                  • Properties for Alarms

                                                                                                                                  property metric

                                                                                                                                  readonly metric: IMetric;
                                                                                                                                  • The metric to add the alarm on

                                                                                                                                    Metric objects can be obtained from most resources, or you can construct custom Metric objects by instantiating one.

                                                                                                                                  interface AlarmStatusWidgetProps

                                                                                                                                  interface AlarmStatusWidgetProps {}
                                                                                                                                  • Properties for an Alarm Status Widget

                                                                                                                                  property alarms

                                                                                                                                  readonly alarms: IAlarm[];
                                                                                                                                  • CloudWatch Alarms to show in widget

                                                                                                                                  property height

                                                                                                                                  readonly height?: number;
                                                                                                                                  • Height of the widget

                                                                                                                                    3

                                                                                                                                  property sortBy

                                                                                                                                  readonly sortBy?: AlarmStatusWidgetSortBy;
                                                                                                                                  • Specifies how to sort the alarms in the widget.

                                                                                                                                    - alphabetical order

                                                                                                                                  property states

                                                                                                                                  readonly states?: AlarmState[];
                                                                                                                                  • Use this field to filter the list of alarms displayed in the widget to only those alarms currently in the specified states. You can specify one or more alarm states in the value for this field. The alarm states that you can specify are ALARM, INSUFFICIENT_DATA, and OK.

                                                                                                                                    If you omit this field or specify an empty array, all the alarms specifed in alarms are displayed.

                                                                                                                                    - all the alarms specified in alarms are displayed.

                                                                                                                                  property title

                                                                                                                                  readonly title?: string;
                                                                                                                                  • The title of the widget

                                                                                                                                    'Alarm Status'

                                                                                                                                  property width

                                                                                                                                  readonly width?: number;
                                                                                                                                  • Width of the widget, in a grid of 24 units wide

                                                                                                                                    6

                                                                                                                                  interface AlarmWidgetProps

                                                                                                                                  interface AlarmWidgetProps extends MetricWidgetProps {}
                                                                                                                                  • Properties for an AlarmWidget

                                                                                                                                  property alarm

                                                                                                                                  readonly alarm: IAlarm;
                                                                                                                                  • The alarm to show

                                                                                                                                  property leftYAxis

                                                                                                                                  readonly leftYAxis?: YAxisProps;
                                                                                                                                  • Left Y axis

                                                                                                                                    - No minimum or maximum values for the left Y-axis

                                                                                                                                  interface CfnAlarmProps

                                                                                                                                  interface CfnAlarmProps {}
                                                                                                                                  • Properties for defining a CfnAlarm

                                                                                                                                    external

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

                                                                                                                                  property actionsEnabled

                                                                                                                                  readonly actionsEnabled?: boolean | cdk.IResolvable;
                                                                                                                                  • 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-properties-cw-alarm.html#cfn-cloudwatch-alarms-actionsenabled

                                                                                                                                  property alarmActions

                                                                                                                                  readonly 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-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmactions

                                                                                                                                  property alarmDescription

                                                                                                                                  readonly alarmDescription?: string;
                                                                                                                                  • The description of the alarm.

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

                                                                                                                                  property alarmName

                                                                                                                                  readonly 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-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmname

                                                                                                                                  property comparisonOperator

                                                                                                                                  readonly 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-properties-cw-alarm.html#cfn-cloudwatch-alarms-comparisonoperator

                                                                                                                                  property datapointsToAlarm

                                                                                                                                  readonly 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-properties-cw-alarm.html#cfn-cloudwatch-alarm-datapointstoalarm

                                                                                                                                  property dimensions

                                                                                                                                  readonly dimensions?:
                                                                                                                                  | Array<CfnAlarm.DimensionProperty | cdk.IResolvable>
                                                                                                                                  | cdk.IResolvable;
                                                                                                                                  • 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-properties-cw-alarm.html#cfn-cloudwatch-alarms-dimension

                                                                                                                                  property evaluateLowSampleCountPercentile

                                                                                                                                  readonly 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-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluatelowsamplecountpercentile

                                                                                                                                  property evaluationPeriods

                                                                                                                                  readonly 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-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluationperiods

                                                                                                                                  property extendedStatistic

                                                                                                                                  readonly 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-properties-cw-alarm.html#cfn-cloudwatch-alarms-extendedstatistic

                                                                                                                                  property insufficientDataActions

                                                                                                                                  readonly 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-properties-cw-alarm.html#cfn-cloudwatch-alarms-insufficientdataactions

                                                                                                                                  property metricName

                                                                                                                                  readonly 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-properties-cw-alarm.html#cfn-cloudwatch-alarms-metricname

                                                                                                                                  property metrics

                                                                                                                                  readonly metrics?:
                                                                                                                                  | Array<CfnAlarm.MetricDataQueryProperty | cdk.IResolvable>
                                                                                                                                  | cdk.IResolvable;
                                                                                                                                  • 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-properties-cw-alarm.html#cfn-cloudwatch-alarm-metrics

                                                                                                                                  property namespace

                                                                                                                                  readonly 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-properties-cw-alarm.html#cfn-cloudwatch-alarms-namespace

                                                                                                                                  property okActions

                                                                                                                                  readonly 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-properties-cw-alarm.html#cfn-cloudwatch-alarms-okactions

                                                                                                                                  property period

                                                                                                                                  readonly 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-properties-cw-alarm.html#cfn-cloudwatch-alarms-period

                                                                                                                                  property statistic

                                                                                                                                  readonly 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-properties-cw-alarm.html#cfn-cloudwatch-alarms-statistic

                                                                                                                                  property threshold

                                                                                                                                  readonly threshold?: number;
                                                                                                                                  • The value to compare with the specified statistic.

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

                                                                                                                                  property thresholdMetricId

                                                                                                                                  readonly 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-properties-cw-alarm.html#cfn-cloudwatch-alarms-dynamic-threshold

                                                                                                                                  property treatMissingData

                                                                                                                                  readonly 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-properties-cw-alarm.html#cfn-cloudwatch-alarms-treatmissingdata

                                                                                                                                  property unit

                                                                                                                                  readonly 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-properties-cw-alarm.html#cfn-cloudwatch-alarms-unit

                                                                                                                                  interface CfnAnomalyDetectorProps

                                                                                                                                  interface CfnAnomalyDetectorProps {}
                                                                                                                                  • Properties for defining a CfnAnomalyDetector

                                                                                                                                    external

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

                                                                                                                                  property configuration

                                                                                                                                  readonly configuration?:
                                                                                                                                  | CfnAnomalyDetector.ConfigurationProperty
                                                                                                                                  | cdk.IResolvable;
                                                                                                                                  • 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

                                                                                                                                  readonly dimensions?:
                                                                                                                                  | Array<CfnAnomalyDetector.DimensionProperty | cdk.IResolvable>
                                                                                                                                  | cdk.IResolvable;
                                                                                                                                  • 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

                                                                                                                                  readonly metricMathAnomalyDetector?:
                                                                                                                                  | CfnAnomalyDetector.MetricMathAnomalyDetectorProperty
                                                                                                                                  | cdk.IResolvable;
                                                                                                                                  • 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

                                                                                                                                  readonly 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

                                                                                                                                  readonly 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

                                                                                                                                  readonly singleMetricAnomalyDetector?:
                                                                                                                                  | CfnAnomalyDetector.SingleMetricAnomalyDetectorProperty
                                                                                                                                  | cdk.IResolvable;
                                                                                                                                  • 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

                                                                                                                                  readonly 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

                                                                                                                                  interface CfnCompositeAlarmProps

                                                                                                                                  interface CfnCompositeAlarmProps {}
                                                                                                                                  • Properties for defining a CfnCompositeAlarm

                                                                                                                                    external

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

                                                                                                                                  property actionsEnabled

                                                                                                                                  readonly actionsEnabled?: boolean | cdk.IResolvable;
                                                                                                                                  • 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 alarmActions

                                                                                                                                  readonly 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

                                                                                                                                  readonly 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

                                                                                                                                  readonly 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

                                                                                                                                  readonly 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 insufficientDataActions

                                                                                                                                  readonly 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

                                                                                                                                  readonly 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

                                                                                                                                  interface CfnDashboardProps

                                                                                                                                  interface CfnDashboardProps {}
                                                                                                                                  • Properties for defining a CfnDashboard

                                                                                                                                    external

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

                                                                                                                                  property dashboardBody

                                                                                                                                  readonly 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

                                                                                                                                  readonly 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

                                                                                                                                  interface CfnInsightRuleProps

                                                                                                                                  interface CfnInsightRuleProps {}
                                                                                                                                  • Properties for defining a CfnInsightRule

                                                                                                                                    external

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

                                                                                                                                  property ruleBody

                                                                                                                                  readonly 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

                                                                                                                                  readonly 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

                                                                                                                                  readonly 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?: Array<cdk.CfnTag | cdk.IResolvable> | cdk.IResolvable;
                                                                                                                                  • 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

                                                                                                                                  interface CfnMetricStreamProps

                                                                                                                                  interface CfnMetricStreamProps {}
                                                                                                                                  • Properties for defining a CfnMetricStream

                                                                                                                                    external

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

                                                                                                                                  property excludeFilters

                                                                                                                                  readonly excludeFilters?:
                                                                                                                                  | Array<CfnMetricStream.MetricStreamFilterProperty | cdk.IResolvable>
                                                                                                                                  | cdk.IResolvable;
                                                                                                                                  • 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

                                                                                                                                  readonly 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

                                                                                                                                  readonly includeFilters?:
                                                                                                                                  | Array<CfnMetricStream.MetricStreamFilterProperty | cdk.IResolvable>
                                                                                                                                  | cdk.IResolvable;
                                                                                                                                  • 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 name

                                                                                                                                  readonly 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

                                                                                                                                  readonly 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

                                                                                                                                  readonly 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

                                                                                                                                  readonly statisticsConfigurations?:
                                                                                                                                  | Array<
                                                                                                                                  | CfnMetricStream.MetricStreamStatisticsConfigurationProperty
                                                                                                                                  | cdk.IResolvable
                                                                                                                                  >
                                                                                                                                  | cdk.IResolvable;
                                                                                                                                  • 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.CfnTag[];
                                                                                                                                  • 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

                                                                                                                                  interface CommonMetricOptions

                                                                                                                                  interface CommonMetricOptions {}
                                                                                                                                  • Options shared by most methods accepting metric options

                                                                                                                                  property account

                                                                                                                                  readonly account?: string;
                                                                                                                                  • Account which this metric comes from.

                                                                                                                                    - Deployment account.

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

                                                                                                                                  property dimensions

                                                                                                                                  readonly dimensions?: DimensionHash;
                                                                                                                                  • Dimensions of the metric

                                                                                                                                    - No dimensions.

                                                                                                                                    Deprecated

                                                                                                                                    Use 'dimensionsMap' instead.

                                                                                                                                  property dimensionsMap

                                                                                                                                  readonly dimensionsMap?: DimensionsMap;
                                                                                                                                  • Dimensions of the metric

                                                                                                                                    - No dimensions.

                                                                                                                                  property label

                                                                                                                                  readonly label?: string;
                                                                                                                                  • Label for this metric when added to a Graph in a Dashboard

                                                                                                                                    You can use [dynamic labels](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html) to show summary information about the entire displayed time series in the legend. For example, if you use:

                                                                                                                                    [max: ${MAX}] MyMetric

                                                                                                                                    As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend.

                                                                                                                                    - No label

                                                                                                                                  property period

                                                                                                                                  readonly period?: cdk.Duration;
                                                                                                                                  • The period over which the specified statistic is applied.

                                                                                                                                    Duration.minutes(5)

                                                                                                                                  property region

                                                                                                                                  readonly region?: string;
                                                                                                                                  • Region which this metric comes from.

                                                                                                                                    - Deployment region.

                                                                                                                                  property statistic

                                                                                                                                  readonly statistic?: string;
                                                                                                                                  • What function to use for aggregating.

                                                                                                                                    Can be one of the following:

                                                                                                                                    - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN"

                                                                                                                                    Average

                                                                                                                                  property unit

                                                                                                                                  readonly unit?: Unit;
                                                                                                                                  • Unit used to filter the metric stream

                                                                                                                                    Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units.

                                                                                                                                    The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases.

                                                                                                                                    CloudWatch does not honor this property for graphs.

                                                                                                                                    - All metric datums in the given metric stream

                                                                                                                                  interface CompositeAlarmProps

                                                                                                                                  interface CompositeAlarmProps {}
                                                                                                                                  • Properties for creating a Composite Alarm

                                                                                                                                  property actionsEnabled

                                                                                                                                  readonly actionsEnabled?: boolean;
                                                                                                                                  • Whether the actions for this alarm are enabled

                                                                                                                                    true

                                                                                                                                  property alarmDescription

                                                                                                                                  readonly alarmDescription?: string;
                                                                                                                                  • Description for the alarm

                                                                                                                                    No description

                                                                                                                                  property alarmRule

                                                                                                                                  readonly alarmRule: IAlarmRule;
                                                                                                                                  • Expression that specifies which other alarms are to be evaluated to determine this composite alarm's state.

                                                                                                                                  property compositeAlarmName

                                                                                                                                  readonly compositeAlarmName?: string;
                                                                                                                                  • Name of the alarm

                                                                                                                                    Automatically generated name

                                                                                                                                  interface CreateAlarmOptions

                                                                                                                                  interface CreateAlarmOptions {}
                                                                                                                                  • Properties needed to make an alarm from a metric

                                                                                                                                  property actionsEnabled

                                                                                                                                  readonly actionsEnabled?: boolean;
                                                                                                                                  • Whether the actions for this alarm are enabled

                                                                                                                                    true

                                                                                                                                  property alarmDescription

                                                                                                                                  readonly alarmDescription?: string;
                                                                                                                                  • Description for the alarm

                                                                                                                                    No description

                                                                                                                                  property alarmName

                                                                                                                                  readonly alarmName?: string;
                                                                                                                                  • Name of the alarm

                                                                                                                                    Automatically generated name

                                                                                                                                  property comparisonOperator

                                                                                                                                  readonly comparisonOperator?: ComparisonOperator;
                                                                                                                                  • Comparison to use to check if metric is breaching

                                                                                                                                    GreaterThanOrEqualToThreshold

                                                                                                                                  property datapointsToAlarm

                                                                                                                                  readonly 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. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide.

                                                                                                                                    ``evaluationPeriods``

                                                                                                                                    See Also

                                                                                                                                    • https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation

                                                                                                                                  property evaluateLowSampleCountPercentile

                                                                                                                                  readonly evaluateLowSampleCountPercentile?: string;
                                                                                                                                  • Specifies whether to evaluate the data and potentially change the alarm state if there are too few data points to be statistically significant.

                                                                                                                                    Used only for alarms that are based on percentiles.

                                                                                                                                    - Not configured.

                                                                                                                                  property evaluationPeriods

                                                                                                                                  readonly evaluationPeriods: number;
                                                                                                                                  • The number of periods over which data is compared to the specified threshold.

                                                                                                                                  property period

                                                                                                                                  readonly period?: cdk.Duration;
                                                                                                                                  • The period over which the specified statistic is applied.

                                                                                                                                    Cannot be used with MathExpression objects.

                                                                                                                                    - The period from the metric

                                                                                                                                    Deprecated

                                                                                                                                    Use metric.with({ period: ... }) to encode the period into the Metric object

                                                                                                                                  property statistic

                                                                                                                                  readonly statistic?: string;
                                                                                                                                  • What function to use for aggregating.

                                                                                                                                    Can be one of the following:

                                                                                                                                    - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN"

                                                                                                                                    Cannot be used with MathExpression objects.

                                                                                                                                    - The statistic from the metric

                                                                                                                                    Deprecated

                                                                                                                                    Use metric.with({ statistic: ... }) to encode the period into the Metric object

                                                                                                                                  property threshold

                                                                                                                                  readonly threshold: number;
                                                                                                                                  • The value against which the specified statistic is compared.

                                                                                                                                  property treatMissingData

                                                                                                                                  readonly treatMissingData?: TreatMissingData;
                                                                                                                                  • Sets how this alarm is to handle missing data points.

                                                                                                                                    TreatMissingData.Missing

                                                                                                                                  interface CustomWidgetProps

                                                                                                                                  interface CustomWidgetProps {}
                                                                                                                                  • The properties for a CustomWidget

                                                                                                                                  property functionArn

                                                                                                                                  readonly functionArn: string;
                                                                                                                                  • The Arn of the AWS Lambda function that returns HTML or JSON that will be displayed in the widget

                                                                                                                                  property height

                                                                                                                                  readonly height?: number;
                                                                                                                                  • Height of the widget

                                                                                                                                    - 6 for Alarm and Graph widgets. 3 for single value widgets where most recent value of a metric is displayed.

                                                                                                                                  property params

                                                                                                                                  readonly params?: any;
                                                                                                                                  • Parameters passed to the lambda function

                                                                                                                                    - no parameters are passed to the lambda function

                                                                                                                                  property title

                                                                                                                                  readonly title: string;
                                                                                                                                  • The title of the widget

                                                                                                                                  property updateOnRefresh

                                                                                                                                  readonly updateOnRefresh?: boolean;
                                                                                                                                  • Update the widget on refresh

                                                                                                                                    true

                                                                                                                                  property updateOnResize

                                                                                                                                  readonly updateOnResize?: boolean;
                                                                                                                                  • Update the widget on resize

                                                                                                                                    true

                                                                                                                                  property updateOnTimeRangeChange

                                                                                                                                  readonly updateOnTimeRangeChange?: boolean;
                                                                                                                                  • Update the widget on time range change

                                                                                                                                    true

                                                                                                                                  property width

                                                                                                                                  readonly width?: number;
                                                                                                                                  • Width of the widget, in a grid of 24 units wide

                                                                                                                                    6

                                                                                                                                  interface DashboardProps

                                                                                                                                  interface DashboardProps {}
                                                                                                                                  • Properties for defining a CloudWatch Dashboard

                                                                                                                                  property dashboardName

                                                                                                                                  readonly dashboardName?: string;
                                                                                                                                  • Name of the dashboard.

                                                                                                                                    If set, must only contain alphanumerics, dash (-) and underscore (_)

                                                                                                                                    - automatically generated name

                                                                                                                                  property end

                                                                                                                                  readonly end?: string;
                                                                                                                                  • The end of the time range to use for each widget on the dashboard when the dashboard loads. If you specify a value for end, you must also specify a value for start. Specify an absolute time in the ISO 8601 format. For example, 2018-12-17T06:00:00.000Z.

                                                                                                                                    When the dashboard loads, the end date will be the current time.

                                                                                                                                  property periodOverride

                                                                                                                                  readonly periodOverride?: PeriodOverride;
                                                                                                                                  • Use this field to specify the period for the graphs when the dashboard loads. Specifying Auto causes the period of all graphs on the dashboard to automatically adapt to the time range of the dashboard. Specifying Inherit ensures that the period set for each graph is always obeyed.

                                                                                                                                    Auto

                                                                                                                                  property start

                                                                                                                                  readonly start?: string;
                                                                                                                                  • The start of the time range to use for each widget on the dashboard. You can specify start without specifying end to specify a relative time range that ends with the current time. In this case, the value of start must begin with -P, and you can use M, H, D, W and M as abbreviations for minutes, hours, days, weeks and months. For example, -PT8H shows the last 8 hours and -P3M shows the last three months. You can also use start along with an end field, to specify an absolute time range. When specifying an absolute time range, use the ISO 8601 format. For example, 2018-12-17T06:00:00.000Z.

                                                                                                                                    When the dashboard loads, the start time will be the default time range.

                                                                                                                                  property widgets

                                                                                                                                  readonly widgets?: IWidget[][];
                                                                                                                                  • Initial set of widgets on the dashboard

                                                                                                                                    One array represents a row of widgets.

                                                                                                                                    - No widgets

                                                                                                                                  interface Dimension

                                                                                                                                  interface Dimension {}
                                                                                                                                  • Metric dimension

                                                                                                                                    See Also

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

                                                                                                                                  property name

                                                                                                                                  readonly name: string;
                                                                                                                                  • Name of the dimension

                                                                                                                                  property value

                                                                                                                                  readonly value: any;
                                                                                                                                  • Value of the dimension

                                                                                                                                  interface GraphWidgetProps

                                                                                                                                  interface GraphWidgetProps extends MetricWidgetProps {}
                                                                                                                                  • Properties for a GraphWidget

                                                                                                                                  property left

                                                                                                                                  readonly left?: IMetric[];
                                                                                                                                  • Metrics to display on left Y axis

                                                                                                                                    - No metrics

                                                                                                                                  property leftAnnotations

                                                                                                                                  readonly leftAnnotations?: HorizontalAnnotation[];
                                                                                                                                  • Annotations for the left Y axis

                                                                                                                                    - No annotations

                                                                                                                                  property leftYAxis

                                                                                                                                  readonly leftYAxis?: YAxisProps;
                                                                                                                                  • Left Y axis

                                                                                                                                    - None

                                                                                                                                  property legendPosition

                                                                                                                                  readonly legendPosition?: LegendPosition;
                                                                                                                                  • Position of the legend

                                                                                                                                    - bottom

                                                                                                                                  property liveData

                                                                                                                                  readonly liveData?: boolean;
                                                                                                                                  • Whether the graph should show live data

                                                                                                                                    false

                                                                                                                                  property period

                                                                                                                                  readonly period?: cdk.Duration;
                                                                                                                                  • The default period for all metrics in this widget. The period is the length of time represented by one data point on the graph. This default can be overridden within each metric definition.

                                                                                                                                    cdk.Duration.seconds(300)

                                                                                                                                  property right

                                                                                                                                  readonly right?: IMetric[];
                                                                                                                                  • Metrics to display on right Y axis

                                                                                                                                    - No metrics

                                                                                                                                  property rightAnnotations

                                                                                                                                  readonly rightAnnotations?: HorizontalAnnotation[];
                                                                                                                                  • Annotations for the right Y axis

                                                                                                                                    - No annotations

                                                                                                                                  property rightYAxis

                                                                                                                                  readonly rightYAxis?: YAxisProps;
                                                                                                                                  • Right Y axis

                                                                                                                                    - None

                                                                                                                                  property setPeriodToTimeRange

                                                                                                                                  readonly setPeriodToTimeRange?: boolean;
                                                                                                                                  • Whether to show the value from the entire time range. Only applicable for Bar and Pie charts.

                                                                                                                                    If false, values will be from the most recent period of your chosen time range; if true, shows the value from the entire time range.

                                                                                                                                    false

                                                                                                                                  property stacked

                                                                                                                                  readonly stacked?: boolean;
                                                                                                                                  • Whether the graph should be shown as stacked lines

                                                                                                                                    false

                                                                                                                                  property statistic

                                                                                                                                  readonly statistic?: string;
                                                                                                                                  • The default statistic to be displayed for each metric. This default can be overridden within the definition of each individual metric

                                                                                                                                    - The statistic for each metric is used

                                                                                                                                  property view

                                                                                                                                  readonly view?: GraphWidgetView;
                                                                                                                                  • Display this metric

                                                                                                                                    TimeSeries

                                                                                                                                  interface HorizontalAnnotation

                                                                                                                                  interface HorizontalAnnotation {}
                                                                                                                                  • Horizontal annotation to be added to a graph

                                                                                                                                  property color

                                                                                                                                  readonly color?: string;
                                                                                                                                  • The hex color code, prefixed with '#' (e.g. '#00ff00'), to be used for the annotation. The Color class has a set of standard colors that can be used here.

                                                                                                                                    - Automatic color

                                                                                                                                  property fill

                                                                                                                                  readonly fill?: Shading;
                                                                                                                                  • Add shading above or below the annotation

                                                                                                                                    No shading

                                                                                                                                  property label

                                                                                                                                  readonly label?: string;
                                                                                                                                  • Label for the annotation

                                                                                                                                    - No label

                                                                                                                                  property value

                                                                                                                                  readonly value: number;
                                                                                                                                  • The value of the annotation

                                                                                                                                  property visible

                                                                                                                                  readonly visible?: boolean;
                                                                                                                                  • Whether the annotation is visible

                                                                                                                                    true

                                                                                                                                  interface IAlarm

                                                                                                                                  interface IAlarm extends IAlarmRule, IResource {}
                                                                                                                                  • Represents a CloudWatch Alarm

                                                                                                                                  property alarmArn

                                                                                                                                  readonly alarmArn: string;
                                                                                                                                  • Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo)

                                                                                                                                  property alarmName

                                                                                                                                  readonly alarmName: string;
                                                                                                                                  • Name of the alarm

                                                                                                                                  interface IAlarmAction

                                                                                                                                  interface IAlarmAction {}
                                                                                                                                  • Interface for objects that can be the targets of CloudWatch alarm actions

                                                                                                                                  method bind

                                                                                                                                  bind: (scope: Construct, alarm: IAlarm) => AlarmActionConfig;
                                                                                                                                  • Return the properties required to send alarm actions to this CloudWatch alarm.

                                                                                                                                    Parameter scope

                                                                                                                                    root Construct that allows creating new Constructs

                                                                                                                                    Parameter alarm

                                                                                                                                    CloudWatch alarm that the action will target

                                                                                                                                  interface IAlarmRule

                                                                                                                                  interface IAlarmRule {}
                                                                                                                                  • Interface for Alarm Rule.

                                                                                                                                  method renderAlarmRule

                                                                                                                                  renderAlarmRule: () => string;
                                                                                                                                  • serialized representation of Alarm Rule to be used when building the Composite Alarm resource.

                                                                                                                                  interface IMetric

                                                                                                                                  interface IMetric {}
                                                                                                                                  • Interface for metrics

                                                                                                                                  property warnings

                                                                                                                                  readonly warnings?: string[];
                                                                                                                                  • Any warnings related to this metric

                                                                                                                                    Should be attached to the consuming construct.

                                                                                                                                    - None

                                                                                                                                  method toAlarmConfig

                                                                                                                                  toAlarmConfig: () => MetricAlarmConfig;
                                                                                                                                  • Turn this metric object into an alarm configuration

                                                                                                                                    Deprecated

                                                                                                                                    Use toMetricConfig() instead.

                                                                                                                                  method toGraphConfig

                                                                                                                                  toGraphConfig: () => MetricGraphConfig;
                                                                                                                                  • Turn this metric object into a graph configuration

                                                                                                                                    Deprecated

                                                                                                                                    Use toMetricConfig() instead.

                                                                                                                                  method toMetricConfig

                                                                                                                                  toMetricConfig: () => MetricConfig;
                                                                                                                                  • Inspect the details of the metric object

                                                                                                                                  interface IWidget

                                                                                                                                  interface IWidget {}
                                                                                                                                  • A single dashboard widget

                                                                                                                                  property height

                                                                                                                                  readonly height: number;
                                                                                                                                  • The amount of vertical grid units the widget will take up

                                                                                                                                  property warnings

                                                                                                                                  readonly warnings?: string[];
                                                                                                                                  • Any warnings that are produced as a result of putting together this widget

                                                                                                                                  property width

                                                                                                                                  readonly width: number;
                                                                                                                                  • The amount of horizontal grid units the widget will take up

                                                                                                                                  method position

                                                                                                                                  position: (x: number, y: number) => void;
                                                                                                                                  • Place the widget at a given position

                                                                                                                                  method toJson

                                                                                                                                  toJson: () => any[];
                                                                                                                                  • Return the widget JSON for use in the dashboard

                                                                                                                                  interface LogQueryWidgetProps

                                                                                                                                  interface LogQueryWidgetProps {}
                                                                                                                                  • Properties for a Query widget

                                                                                                                                  property height

                                                                                                                                  readonly height?: number;
                                                                                                                                  • Height of the widget

                                                                                                                                    6

                                                                                                                                  property logGroupNames

                                                                                                                                  readonly logGroupNames: string[];
                                                                                                                                  • Names of log groups to query

                                                                                                                                  property queryLines

                                                                                                                                  readonly queryLines?: string[];
                                                                                                                                  • A sequence of lines to use to build the query

                                                                                                                                    The query will be built by joining the lines together using \n|.

                                                                                                                                    - Exactly one of queryString, queryLines is required.

                                                                                                                                  property queryString

                                                                                                                                  readonly queryString?: string;
                                                                                                                                  • Full query string for log insights

                                                                                                                                    Be sure to prepend every new line with a newline and pipe character (\n|).

                                                                                                                                    - Exactly one of queryString, queryLines is required.

                                                                                                                                  property region

                                                                                                                                  readonly region?: string;
                                                                                                                                  • The region the metrics of this widget should be taken from

                                                                                                                                    Current region

                                                                                                                                  property title

                                                                                                                                  readonly title?: string;
                                                                                                                                  • Title for the widget

                                                                                                                                    No title

                                                                                                                                  property view

                                                                                                                                  readonly view?: LogQueryVisualizationType;
                                                                                                                                  • The type of view to use

                                                                                                                                    LogQueryVisualizationType.TABLE

                                                                                                                                  property width

                                                                                                                                  readonly width?: number;
                                                                                                                                  • Width of the widget, in a grid of 24 units wide

                                                                                                                                    6

                                                                                                                                  interface MathExpressionOptions

                                                                                                                                  interface MathExpressionOptions {}
                                                                                                                                  • Configurable options for MathExpressions

                                                                                                                                  property color

                                                                                                                                  readonly color?: string;
                                                                                                                                  • Color for this metric when added to a Graph in a Dashboard

                                                                                                                                    - Automatic color

                                                                                                                                  property label

                                                                                                                                  readonly label?: string;
                                                                                                                                  • Label for this expression when added to a Graph in a Dashboard

                                                                                                                                    If this expression evaluates to more than one time series (for example, through the use of METRICS() or SEARCH() expressions), each time series will appear in the graph using a combination of the expression label and the individual metric label. Specify the empty string ('') to suppress the expression label and only keep the metric label.

                                                                                                                                    You can use [dynamic labels](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html) to show summary information about the displayed time series in the legend. For example, if you use:

                                                                                                                                    [max: ${MAX}] MyMetric

                                                                                                                                    As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. If the math expression produces more than one time series, the maximum will be shown for each individual time series produce by this math expression.

                                                                                                                                    - Expression value is used as label

                                                                                                                                  property period

                                                                                                                                  readonly period?: cdk.Duration;
                                                                                                                                  • The period over which the expression's statistics are applied.

                                                                                                                                    This period overrides all periods in the metrics used in this math expression.

                                                                                                                                    Duration.minutes(5)

                                                                                                                                  property searchAccount

                                                                                                                                  readonly searchAccount?: string;
                                                                                                                                  • Account to evaluate search expressions within.

                                                                                                                                    Specifying a searchAccount has no effect to the account used for metrics within the expression (passed via usingMetrics).

                                                                                                                                    - Deployment account.

                                                                                                                                  property searchRegion

                                                                                                                                  readonly searchRegion?: string;
                                                                                                                                  • Region to evaluate search expressions within.

                                                                                                                                    Specifying a searchRegion has no effect to the region used for metrics within the expression (passed via usingMetrics).

                                                                                                                                    - Deployment region.

                                                                                                                                  interface MathExpressionProps

                                                                                                                                  interface MathExpressionProps extends MathExpressionOptions {}
                                                                                                                                  • Properties for a MathExpression

                                                                                                                                  property expression

                                                                                                                                  readonly expression: string;
                                                                                                                                  • The expression defining the metric.

                                                                                                                                    When an expression contains a SEARCH function, it cannot be used within an Alarm.

                                                                                                                                  property usingMetrics

                                                                                                                                  readonly usingMetrics?: Record<string, IMetric>;
                                                                                                                                  • The metrics used in the expression, in a map.

                                                                                                                                    The key is the identifier that represents the given metric in the expression, and the value is the actual Metric object.

                                                                                                                                    - Empty map.

                                                                                                                                  interface MetricAlarmConfig

                                                                                                                                  interface MetricAlarmConfig {}
                                                                                                                                  • Properties used to construct the Metric identifying part of an Alarm

                                                                                                                                    Deprecated

                                                                                                                                    Replaced by MetricConfig

                                                                                                                                  property dimensions

                                                                                                                                  readonly dimensions?: Dimension[];
                                                                                                                                  • The dimensions to apply to the alarm

                                                                                                                                  property extendedStatistic

                                                                                                                                  readonly extendedStatistic?: string;
                                                                                                                                  • Percentile aggregation function to use

                                                                                                                                  property metricName

                                                                                                                                  readonly metricName: string;
                                                                                                                                  • Name of the metric

                                                                                                                                  property namespace

                                                                                                                                  readonly namespace: string;
                                                                                                                                  • Namespace of the metric

                                                                                                                                  property period

                                                                                                                                  readonly period: number;
                                                                                                                                  • How many seconds to aggregate over

                                                                                                                                  property statistic

                                                                                                                                  readonly statistic?: Statistic;
                                                                                                                                  • Simple aggregation function to use

                                                                                                                                  property unit

                                                                                                                                  readonly unit?: Unit;
                                                                                                                                  • The unit of the alarm

                                                                                                                                  interface MetricConfig

                                                                                                                                  interface MetricConfig {}
                                                                                                                                  • Properties of a rendered metric

                                                                                                                                  property mathExpression

                                                                                                                                  readonly mathExpression?: MetricExpressionConfig;
                                                                                                                                  • In case the metric is a math expression, the details of the math expression

                                                                                                                                    - None

                                                                                                                                  property metricStat

                                                                                                                                  readonly metricStat?: MetricStatConfig;
                                                                                                                                  • In case the metric represents a query, the details of the query

                                                                                                                                    - None

                                                                                                                                  property renderingProperties

                                                                                                                                  readonly renderingProperties?: Record<string, unknown>;
                                                                                                                                  • Additional properties which will be rendered if the metric is used in a dashboard

                                                                                                                                    Examples are 'label' and 'color', but any key in here will be added to dashboard graphs.

                                                                                                                                    - None

                                                                                                                                  interface MetricExpressionConfig

                                                                                                                                  interface MetricExpressionConfig {}
                                                                                                                                  • Properties for a concrete metric

                                                                                                                                  property expression

                                                                                                                                  readonly expression: string;
                                                                                                                                  • Math expression for the metric.

                                                                                                                                  property period

                                                                                                                                  readonly period: number;
                                                                                                                                  • How many seconds to aggregate over

                                                                                                                                  property searchAccount

                                                                                                                                  readonly searchAccount?: string;
                                                                                                                                  • Account to evaluate search expressions within.

                                                                                                                                    - Deployment account.

                                                                                                                                  property searchRegion

                                                                                                                                  readonly searchRegion?: string;
                                                                                                                                  • Region to evaluate search expressions within.

                                                                                                                                    - Deployment region.

                                                                                                                                  property usingMetrics

                                                                                                                                  readonly usingMetrics: Record<string, IMetric>;
                                                                                                                                  • Metrics used in the math expression

                                                                                                                                  interface MetricGraphConfig

                                                                                                                                  interface MetricGraphConfig {}
                                                                                                                                  • Properties used to construct the Metric identifying part of a Graph

                                                                                                                                    Deprecated

                                                                                                                                    Replaced by MetricConfig

                                                                                                                                  property color

                                                                                                                                  readonly color?: string;
                                                                                                                                  • Color for the graph line

                                                                                                                                    Deprecated

                                                                                                                                    Use color in renderingProperties

                                                                                                                                  property dimensions

                                                                                                                                  readonly dimensions?: Dimension[];
                                                                                                                                  • The dimensions to apply to the alarm

                                                                                                                                  property label

                                                                                                                                  readonly label?: string;
                                                                                                                                  • Label for the metric

                                                                                                                                    Deprecated

                                                                                                                                    Use label in renderingProperties

                                                                                                                                  property metricName

                                                                                                                                  readonly metricName: string;
                                                                                                                                  • Name of the metric

                                                                                                                                  property namespace

                                                                                                                                  readonly namespace: string;
                                                                                                                                  • Namespace of the metric

                                                                                                                                  property period

                                                                                                                                  readonly period: number;
                                                                                                                                  • How many seconds to aggregate over

                                                                                                                                    Deprecated

                                                                                                                                    Use period in renderingProperties

                                                                                                                                  property renderingProperties

                                                                                                                                  readonly renderingProperties: MetricRenderingProperties;
                                                                                                                                  • Rendering properties override yAxis parameter of the widget object

                                                                                                                                  property statistic

                                                                                                                                  readonly statistic?: string;
                                                                                                                                  • Aggregation function to use (can be either simple or a percentile)

                                                                                                                                    Deprecated

                                                                                                                                    Use stat in renderingProperties

                                                                                                                                  property unit

                                                                                                                                  readonly unit?: Unit;
                                                                                                                                  • The unit of the alarm

                                                                                                                                    Deprecated

                                                                                                                                    not used in dashboard widgets

                                                                                                                                  interface MetricOptions

                                                                                                                                  interface MetricOptions extends CommonMetricOptions {}
                                                                                                                                  • Properties of a metric that can be changed

                                                                                                                                  interface MetricProps

                                                                                                                                  interface MetricProps extends CommonMetricOptions {}
                                                                                                                                  • Properties for a metric

                                                                                                                                  property metricName

                                                                                                                                  readonly metricName: string;
                                                                                                                                  • Name of the metric.

                                                                                                                                  property namespace

                                                                                                                                  readonly namespace: string;
                                                                                                                                  • Namespace of the metric.

                                                                                                                                  interface MetricRenderingProperties

                                                                                                                                  interface MetricRenderingProperties {}
                                                                                                                                  • Custom rendering properties that override the default rendering properties specified in the yAxis parameter of the widget object.

                                                                                                                                    Deprecated

                                                                                                                                    Replaced by MetricConfig.

                                                                                                                                  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 label

                                                                                                                                  readonly label?: string;
                                                                                                                                  • Label for the metric

                                                                                                                                  property period

                                                                                                                                  readonly period: number;
                                                                                                                                  • How many seconds to aggregate over

                                                                                                                                  property stat

                                                                                                                                  readonly stat?: string;
                                                                                                                                  • Aggregation function to use (can be either simple or a percentile)

                                                                                                                                  interface MetricStatConfig

                                                                                                                                  interface MetricStatConfig {}
                                                                                                                                  • Properties for a concrete metric

                                                                                                                                    NOTE: unit is no longer on this object since it is only used for Alarms, and doesn't mean what one would expect it to mean there anyway. It is most likely to be misused.

                                                                                                                                  property account

                                                                                                                                  readonly account?: string;
                                                                                                                                  • Account which this metric comes from.

                                                                                                                                    Deployment account.

                                                                                                                                  property dimensions

                                                                                                                                  readonly dimensions?: Dimension[];
                                                                                                                                  • The dimensions to apply to the alarm

                                                                                                                                    []

                                                                                                                                  property metricName

                                                                                                                                  readonly metricName: string;
                                                                                                                                  • Name of the metric

                                                                                                                                  property namespace

                                                                                                                                  readonly namespace: string;
                                                                                                                                  • Namespace of the metric

                                                                                                                                  property period

                                                                                                                                  readonly period: Duration;
                                                                                                                                  • How many seconds to aggregate over

                                                                                                                                  property region

                                                                                                                                  readonly region?: string;
                                                                                                                                  • Region which this metric comes from.

                                                                                                                                    Deployment region.

                                                                                                                                  property statistic

                                                                                                                                  readonly statistic: string;
                                                                                                                                  • Aggregation function to use (can be either simple or a percentile)

                                                                                                                                  property unitFilter

                                                                                                                                  readonly unitFilter?: Unit;
                                                                                                                                  • Unit used to filter the metric stream

                                                                                                                                    Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units.

                                                                                                                                    This field has been renamed from plain unit to clearly communicate its purpose.

                                                                                                                                    - Refer to all metric datums

                                                                                                                                  interface MetricWidgetProps

                                                                                                                                  interface MetricWidgetProps {}
                                                                                                                                  • Basic properties for widgets that display metrics

                                                                                                                                  property height

                                                                                                                                  readonly height?: number;
                                                                                                                                  • Height of the widget

                                                                                                                                    - 6 for Alarm and Graph widgets. 3 for single value widgets where most recent value of a metric is displayed.

                                                                                                                                  property region

                                                                                                                                  readonly region?: string;
                                                                                                                                  • The region the metrics of this graph should be taken from

                                                                                                                                    - Current region

                                                                                                                                  property title

                                                                                                                                  readonly title?: string;
                                                                                                                                  • Title for the graph

                                                                                                                                    - None

                                                                                                                                  property width

                                                                                                                                  readonly width?: number;
                                                                                                                                  • Width of the widget, in a grid of 24 units wide

                                                                                                                                    6

                                                                                                                                  interface SingleValueWidgetProps

                                                                                                                                  interface SingleValueWidgetProps extends MetricWidgetProps {}
                                                                                                                                  • Properties for a SingleValueWidget

                                                                                                                                  property fullPrecision

                                                                                                                                  readonly fullPrecision?: boolean;
                                                                                                                                  • Whether to show as many digits as can fit, before rounding.

                                                                                                                                    false

                                                                                                                                  property metrics

                                                                                                                                  readonly metrics: IMetric[];
                                                                                                                                  • Metrics to display

                                                                                                                                  property setPeriodToTimeRange

                                                                                                                                  readonly setPeriodToTimeRange?: boolean;
                                                                                                                                  • Whether to show the value from the entire time range.

                                                                                                                                    false

                                                                                                                                  interface SpacerProps

                                                                                                                                  interface SpacerProps {}
                                                                                                                                  • Props of the spacer

                                                                                                                                  property height

                                                                                                                                  readonly height?: number;
                                                                                                                                  • Height of the spacer

                                                                                                                                    @default: 1

                                                                                                                                  property width

                                                                                                                                  readonly width?: number;
                                                                                                                                  • Width of the spacer

                                                                                                                                    1

                                                                                                                                  interface TextWidgetProps

                                                                                                                                  interface TextWidgetProps {}
                                                                                                                                  • Properties for a Text widget

                                                                                                                                  property height

                                                                                                                                  readonly height?: number;
                                                                                                                                  • Height of the widget

                                                                                                                                    2

                                                                                                                                  property markdown

                                                                                                                                  readonly markdown: string;
                                                                                                                                  • The text to display, in MarkDown format

                                                                                                                                  property width

                                                                                                                                  readonly width?: number;
                                                                                                                                  • Width of the widget, in a grid of 24 units wide

                                                                                                                                    6

                                                                                                                                  interface YAxisProps

                                                                                                                                  interface YAxisProps {}
                                                                                                                                  • Properties for a Y-Axis

                                                                                                                                  property label

                                                                                                                                  readonly label?: string;
                                                                                                                                  • The label

                                                                                                                                    - No label

                                                                                                                                  property max

                                                                                                                                  readonly max?: number;
                                                                                                                                  • The max value

                                                                                                                                    - No maximum value

                                                                                                                                  property min

                                                                                                                                  readonly min?: number;
                                                                                                                                  • The min value

                                                                                                                                    0

                                                                                                                                  property showUnits

                                                                                                                                  readonly showUnits?: boolean;
                                                                                                                                  • Whether to show units

                                                                                                                                    true

                                                                                                                                  Enums

                                                                                                                                  enum AlarmState

                                                                                                                                  enum AlarmState {
                                                                                                                                  ALARM = 'ALARM',
                                                                                                                                  OK = 'OK',
                                                                                                                                  INSUFFICIENT_DATA = 'INSUFFICIENT_DATA',
                                                                                                                                  }
                                                                                                                                  • Enumeration indicates state of Alarm used in building Alarm Rule.

                                                                                                                                  member ALARM

                                                                                                                                  ALARM = 'ALARM'
                                                                                                                                  • State indicates resource is in ALARM

                                                                                                                                  member INSUFFICIENT_DATA

                                                                                                                                  INSUFFICIENT_DATA = 'INSUFFICIENT_DATA'
                                                                                                                                  • State indicates there is not enough data to determine is resource is in ALARM

                                                                                                                                  member OK

                                                                                                                                  OK = 'OK'
                                                                                                                                  • State indicates resource is not in ALARM

                                                                                                                                  enum AlarmStatusWidgetSortBy

                                                                                                                                  enum AlarmStatusWidgetSortBy {
                                                                                                                                  DEFAULT = 'default',
                                                                                                                                  STATE_UPDATED_TIMESTAMP = 'stateUpdatedTimestamp',
                                                                                                                                  TIMESTAMP = 'timestamp',
                                                                                                                                  }
                                                                                                                                  • The sort possibilities for AlarmStatusWidgets

                                                                                                                                  member DEFAULT

                                                                                                                                  DEFAULT = 'default'
                                                                                                                                  • Choose DEFAULT to sort them in alphabetical order by alarm name.

                                                                                                                                  member STATE_UPDATED_TIMESTAMP

                                                                                                                                  STATE_UPDATED_TIMESTAMP = 'stateUpdatedTimestamp'
                                                                                                                                  • Choose STATE_UPDATED_TIMESTAMP to sort them first by alarm state, with alarms in ALARM state first, INSUFFICIENT_DATA alarms next, and OK alarms last. Within each group, the alarms are sorted by when they last changed state, with more recent state changes listed first.

                                                                                                                                  member TIMESTAMP

                                                                                                                                  TIMESTAMP = 'timestamp'
                                                                                                                                  • Choose TIMESTAMP to sort them by the time when the alarms most recently changed state, no matter the current alarm state. The alarm that changed state most recently is listed first.

                                                                                                                                  enum ComparisonOperator

                                                                                                                                  enum ComparisonOperator {
                                                                                                                                  GREATER_THAN_OR_EQUAL_TO_THRESHOLD = 'GreaterThanOrEqualToThreshold',
                                                                                                                                  GREATER_THAN_THRESHOLD = 'GreaterThanThreshold',
                                                                                                                                  LESS_THAN_THRESHOLD = 'LessThanThreshold',
                                                                                                                                  LESS_THAN_OR_EQUAL_TO_THRESHOLD = 'LessThanOrEqualToThreshold',
                                                                                                                                  LESS_THAN_LOWER_OR_GREATER_THAN_UPPER_THRESHOLD = 'LessThanLowerOrGreaterThanUpperThreshold',
                                                                                                                                  GREATER_THAN_UPPER_THRESHOLD = 'GreaterThanUpperThreshold',
                                                                                                                                  LESS_THAN_LOWER_THRESHOLD = 'LessThanLowerThreshold',
                                                                                                                                  }
                                                                                                                                  • Comparison operator for evaluating alarms

                                                                                                                                  member GREATER_THAN_OR_EQUAL_TO_THRESHOLD

                                                                                                                                  GREATER_THAN_OR_EQUAL_TO_THRESHOLD = 'GreaterThanOrEqualToThreshold'
                                                                                                                                  • Specified statistic is greater than or equal to the threshold

                                                                                                                                  member GREATER_THAN_THRESHOLD

                                                                                                                                  GREATER_THAN_THRESHOLD = 'GreaterThanThreshold'
                                                                                                                                  • Specified statistic is strictly greater than the threshold

                                                                                                                                  member GREATER_THAN_UPPER_THRESHOLD

                                                                                                                                  GREATER_THAN_UPPER_THRESHOLD = 'GreaterThanUpperThreshold'
                                                                                                                                  • Specified statistic is greater than the anomaly model band. Used only for alarms based on anomaly detection models

                                                                                                                                  member LESS_THAN_LOWER_OR_GREATER_THAN_UPPER_THRESHOLD

                                                                                                                                  LESS_THAN_LOWER_OR_GREATER_THAN_UPPER_THRESHOLD = 'LessThanLowerOrGreaterThanUpperThreshold'
                                                                                                                                  • Specified statistic is lower than or greater than the anomaly model band. Used only for alarms based on anomaly detection models

                                                                                                                                  member LESS_THAN_LOWER_THRESHOLD

                                                                                                                                  LESS_THAN_LOWER_THRESHOLD = 'LessThanLowerThreshold'
                                                                                                                                  • Specified statistic is lower than the anomaly model band. Used only for alarms based on anomaly detection models

                                                                                                                                  member LESS_THAN_OR_EQUAL_TO_THRESHOLD

                                                                                                                                  LESS_THAN_OR_EQUAL_TO_THRESHOLD = 'LessThanOrEqualToThreshold'
                                                                                                                                  • Specified statistic is less than or equal to the threshold.

                                                                                                                                  member LESS_THAN_THRESHOLD

                                                                                                                                  LESS_THAN_THRESHOLD = 'LessThanThreshold'
                                                                                                                                  • Specified statistic is strictly less than the threshold

                                                                                                                                  enum GraphWidgetView

                                                                                                                                  enum GraphWidgetView {
                                                                                                                                  TIME_SERIES = 'timeSeries',
                                                                                                                                  BAR = 'bar',
                                                                                                                                  PIE = 'pie',
                                                                                                                                  }
                                                                                                                                  • Types of view

                                                                                                                                  member BAR

                                                                                                                                  BAR = 'bar'
                                                                                                                                  • Display as a bar graph.

                                                                                                                                  member PIE

                                                                                                                                  PIE = 'pie'
                                                                                                                                  • Display as a pie graph.

                                                                                                                                  member TIME_SERIES

                                                                                                                                  TIME_SERIES = 'timeSeries'
                                                                                                                                  • Display as a line graph.

                                                                                                                                  enum LegendPosition

                                                                                                                                  enum LegendPosition {
                                                                                                                                  BOTTOM = 'bottom',
                                                                                                                                  RIGHT = 'right',
                                                                                                                                  HIDDEN = 'hidden',
                                                                                                                                  }
                                                                                                                                  • The position of the legend on a GraphWidget.

                                                                                                                                  member BOTTOM

                                                                                                                                  BOTTOM = 'bottom'
                                                                                                                                  • Legend appears below the graph (default).

                                                                                                                                  member HIDDEN

                                                                                                                                  HIDDEN = 'hidden'
                                                                                                                                  • Add shading below the annotation

                                                                                                                                  member RIGHT

                                                                                                                                  RIGHT = 'right'
                                                                                                                                  • Add shading above the annotation

                                                                                                                                  enum LogQueryVisualizationType

                                                                                                                                  enum LogQueryVisualizationType {
                                                                                                                                  TABLE = 'table',
                                                                                                                                  LINE = 'line',
                                                                                                                                  STACKEDAREA = 'stackedarea',
                                                                                                                                  BAR = 'bar',
                                                                                                                                  PIE = 'pie',
                                                                                                                                  }
                                                                                                                                  • Types of view

                                                                                                                                  member BAR

                                                                                                                                  BAR = 'bar'
                                                                                                                                  • Bar view

                                                                                                                                  member LINE

                                                                                                                                  LINE = 'line'
                                                                                                                                  • Line view

                                                                                                                                  member PIE

                                                                                                                                  PIE = 'pie'
                                                                                                                                  • Pie view

                                                                                                                                  member STACKEDAREA

                                                                                                                                  STACKEDAREA = 'stackedarea'
                                                                                                                                  • Stacked area view

                                                                                                                                  member TABLE

                                                                                                                                  TABLE = 'table'
                                                                                                                                  • Table view

                                                                                                                                  enum PeriodOverride

                                                                                                                                  enum PeriodOverride {
                                                                                                                                  AUTO = 'auto',
                                                                                                                                  INHERIT = 'inherit',
                                                                                                                                  }
                                                                                                                                  • Specify the period for graphs when the CloudWatch dashboard loads

                                                                                                                                  member AUTO

                                                                                                                                  AUTO = 'auto'
                                                                                                                                  • Period of all graphs on the dashboard automatically adapt to the time range of the dashboard.

                                                                                                                                  member INHERIT

                                                                                                                                  INHERIT = 'inherit'
                                                                                                                                  • Period set for each graph will be used

                                                                                                                                  enum Shading

                                                                                                                                  enum Shading {
                                                                                                                                  NONE = 'none',
                                                                                                                                  ABOVE = 'above',
                                                                                                                                  BELOW = 'below',
                                                                                                                                  }
                                                                                                                                  • Fill shading options that will be used with an annotation

                                                                                                                                  member ABOVE

                                                                                                                                  ABOVE = 'above'
                                                                                                                                  • Add shading above the annotation

                                                                                                                                  member BELOW

                                                                                                                                  BELOW = 'below'
                                                                                                                                  • Add shading below the annotation

                                                                                                                                  member NONE

                                                                                                                                  NONE = 'none'
                                                                                                                                  • Don't add shading

                                                                                                                                  enum Statistic

                                                                                                                                  enum Statistic {
                                                                                                                                  SAMPLE_COUNT = 'SampleCount',
                                                                                                                                  AVERAGE = 'Average',
                                                                                                                                  SUM = 'Sum',
                                                                                                                                  MINIMUM = 'Minimum',
                                                                                                                                  MAXIMUM = 'Maximum',
                                                                                                                                  }
                                                                                                                                  • Statistic to use over the aggregation period

                                                                                                                                  member AVERAGE

                                                                                                                                  AVERAGE = 'Average'
                                                                                                                                  • The value of Sum / SampleCount during the specified period.

                                                                                                                                  member MAXIMUM

                                                                                                                                  MAXIMUM = 'Maximum'
                                                                                                                                  • The highest value observed during the specified period. You can use this value to determine high volumes of activity for your application.

                                                                                                                                  member MINIMUM

                                                                                                                                  MINIMUM = 'Minimum'
                                                                                                                                  • The lowest value observed during the specified period. You can use this value to determine low volumes of activity for your application.

                                                                                                                                  member SAMPLE_COUNT

                                                                                                                                  SAMPLE_COUNT = 'SampleCount'
                                                                                                                                  • The count (number) of data points used for the statistical calculation.

                                                                                                                                  member SUM

                                                                                                                                  SUM = 'Sum'
                                                                                                                                  • All values submitted for the matching metric added together. This statistic can be useful for determining the total volume of a metric.

                                                                                                                                  enum TreatMissingData

                                                                                                                                  enum TreatMissingData {
                                                                                                                                  BREACHING = 'breaching',
                                                                                                                                  NOT_BREACHING = 'notBreaching',
                                                                                                                                  IGNORE = 'ignore',
                                                                                                                                  MISSING = 'missing',
                                                                                                                                  }
                                                                                                                                  • Specify how missing data points are treated during alarm evaluation

                                                                                                                                  member BREACHING

                                                                                                                                  BREACHING = 'breaching'
                                                                                                                                  • Missing data points are treated as breaching the threshold

                                                                                                                                  member IGNORE

                                                                                                                                  IGNORE = 'ignore'
                                                                                                                                  • The current alarm state is maintained

                                                                                                                                  member MISSING

                                                                                                                                  MISSING = 'missing'
                                                                                                                                  • The alarm does not consider missing data points when evaluating whether to change state

                                                                                                                                  member NOT_BREACHING

                                                                                                                                  NOT_BREACHING = 'notBreaching'
                                                                                                                                  • Missing data points are treated as being within the threshold

                                                                                                                                  enum Unit

                                                                                                                                  enum Unit {
                                                                                                                                  SECONDS = 'Seconds',
                                                                                                                                  MICROSECONDS = 'Microseconds',
                                                                                                                                  MILLISECONDS = 'Milliseconds',
                                                                                                                                  BYTES = 'Bytes',
                                                                                                                                  KILOBYTES = 'Kilobytes',
                                                                                                                                  MEGABYTES = 'Megabytes',
                                                                                                                                  GIGABYTES = 'Gigabytes',
                                                                                                                                  TERABYTES = 'Terabytes',
                                                                                                                                  BITS = 'Bits',
                                                                                                                                  KILOBITS = 'Kilobits',
                                                                                                                                  MEGABITS = 'Megabits',
                                                                                                                                  GIGABITS = 'Gigabits',
                                                                                                                                  TERABITS = 'Terabits',
                                                                                                                                  PERCENT = 'Percent',
                                                                                                                                  COUNT = 'Count',
                                                                                                                                  BYTES_PER_SECOND = 'Bytes/Second',
                                                                                                                                  KILOBYTES_PER_SECOND = 'Kilobytes/Second',
                                                                                                                                  MEGABYTES_PER_SECOND = 'Megabytes/Second',
                                                                                                                                  GIGABYTES_PER_SECOND = 'Gigabytes/Second',
                                                                                                                                  TERABYTES_PER_SECOND = 'Terabytes/Second',
                                                                                                                                  BITS_PER_SECOND = 'Bits/Second',
                                                                                                                                  KILOBITS_PER_SECOND = 'Kilobits/Second',
                                                                                                                                  MEGABITS_PER_SECOND = 'Megabits/Second',
                                                                                                                                  GIGABITS_PER_SECOND = 'Gigabits/Second',
                                                                                                                                  TERABITS_PER_SECOND = 'Terabits/Second',
                                                                                                                                  COUNT_PER_SECOND = 'Count/Second',
                                                                                                                                  NONE = 'None',
                                                                                                                                  }
                                                                                                                                  • Unit for metric

                                                                                                                                  member BITS

                                                                                                                                  BITS = 'Bits'
                                                                                                                                  • Bits

                                                                                                                                  member BITS_PER_SECOND

                                                                                                                                  BITS_PER_SECOND = 'Bits/Second'
                                                                                                                                  • Bits/second (b/s)

                                                                                                                                  member BYTES

                                                                                                                                  BYTES = 'Bytes'
                                                                                                                                  • Bytes

                                                                                                                                  member BYTES_PER_SECOND

                                                                                                                                  BYTES_PER_SECOND = 'Bytes/Second'
                                                                                                                                  • Bytes/second (B/s)

                                                                                                                                  member COUNT

                                                                                                                                  COUNT = 'Count'
                                                                                                                                  • Count

                                                                                                                                  member COUNT_PER_SECOND

                                                                                                                                  COUNT_PER_SECOND = 'Count/Second'
                                                                                                                                  • Count/second

                                                                                                                                  member GIGABITS

                                                                                                                                  GIGABITS = 'Gigabits'
                                                                                                                                  • Gigabits

                                                                                                                                  member GIGABITS_PER_SECOND

                                                                                                                                  GIGABITS_PER_SECOND = 'Gigabits/Second'
                                                                                                                                  • Gigabits/second (Gb/s)

                                                                                                                                  member GIGABYTES

                                                                                                                                  GIGABYTES = 'Gigabytes'
                                                                                                                                  • Gigabytes

                                                                                                                                  member GIGABYTES_PER_SECOND

                                                                                                                                  GIGABYTES_PER_SECOND = 'Gigabytes/Second'
                                                                                                                                  • Gigabytes/second (GB/s)

                                                                                                                                  member KILOBITS

                                                                                                                                  KILOBITS = 'Kilobits'
                                                                                                                                  • Kilobits

                                                                                                                                  member KILOBITS_PER_SECOND

                                                                                                                                  KILOBITS_PER_SECOND = 'Kilobits/Second'
                                                                                                                                  • Kilobits/second (kb/s)

                                                                                                                                  member KILOBYTES

                                                                                                                                  KILOBYTES = 'Kilobytes'
                                                                                                                                  • Kilobytes

                                                                                                                                  member KILOBYTES_PER_SECOND

                                                                                                                                  KILOBYTES_PER_SECOND = 'Kilobytes/Second'
                                                                                                                                  • Kilobytes/second (kB/s)

                                                                                                                                  member MEGABITS

                                                                                                                                  MEGABITS = 'Megabits'
                                                                                                                                  • Megabits

                                                                                                                                  member MEGABITS_PER_SECOND

                                                                                                                                  MEGABITS_PER_SECOND = 'Megabits/Second'
                                                                                                                                  • Megabits/second (Mb/s)

                                                                                                                                  member MEGABYTES

                                                                                                                                  MEGABYTES = 'Megabytes'
                                                                                                                                  • Megabytes

                                                                                                                                  member MEGABYTES_PER_SECOND

                                                                                                                                  MEGABYTES_PER_SECOND = 'Megabytes/Second'
                                                                                                                                  • Megabytes/second (MB/s)

                                                                                                                                  member MICROSECONDS

                                                                                                                                  MICROSECONDS = 'Microseconds'
                                                                                                                                  • Microseconds

                                                                                                                                  member MILLISECONDS

                                                                                                                                  MILLISECONDS = 'Milliseconds'
                                                                                                                                  • Milliseconds

                                                                                                                                  member NONE

                                                                                                                                  NONE = 'None'
                                                                                                                                  • None

                                                                                                                                  member PERCENT

                                                                                                                                  PERCENT = 'Percent'
                                                                                                                                  • Percent

                                                                                                                                  member SECONDS

                                                                                                                                  SECONDS = 'Seconds'
                                                                                                                                  • Seconds

                                                                                                                                  member TERABITS

                                                                                                                                  TERABITS = 'Terabits'
                                                                                                                                  • Terabits

                                                                                                                                  member TERABITS_PER_SECOND

                                                                                                                                  TERABITS_PER_SECOND = 'Terabits/Second'
                                                                                                                                  • Terabits/second (Tb/s)

                                                                                                                                  member TERABYTES

                                                                                                                                  TERABYTES = 'Terabytes'
                                                                                                                                  • Terabytes

                                                                                                                                  member TERABYTES_PER_SECOND

                                                                                                                                  TERABYTES_PER_SECOND = 'Terabytes/Second'
                                                                                                                                  • Terabytes/second (TB/s)

                                                                                                                                  Type Aliases

                                                                                                                                  type DimensionHash

                                                                                                                                  type DimensionHash = {
                                                                                                                                  [dim: string]: any;
                                                                                                                                  };

                                                                                                                                    type DimensionsMap

                                                                                                                                    type DimensionsMap = {
                                                                                                                                    [dim: string]: string;
                                                                                                                                    };

                                                                                                                                      Namespaces

                                                                                                                                      namespace CfnAlarm

                                                                                                                                      namespace CfnAlarm {}

                                                                                                                                        interface DimensionProperty

                                                                                                                                        interface DimensionProperty {}
                                                                                                                                        • Dimension is an embedded property of the AWS::CloudWatch::Alarm type. Dimensions are name/value pairs that can be associated with a CloudWatch metric. You can specify a maximum of 10 dimensions for a given metric.

                                                                                                                                          external

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

                                                                                                                                        property name

                                                                                                                                        readonly name: string;
                                                                                                                                        • The name of the dimension, from 1–255 characters in length. This dimension name must have been included when the metric was published.

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

                                                                                                                                        property value

                                                                                                                                        readonly value: string;
                                                                                                                                        • The value for the dimension, from 1–255 characters in length.

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

                                                                                                                                        interface MetricDataQueryProperty

                                                                                                                                        interface MetricDataQueryProperty {}
                                                                                                                                        • The MetricDataQuery property type specifies the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data