CfnAnomalyDetectorPropsMixin

class aws_cdk.mixins_preview.aws_cloudwatch.mixins.CfnAnomalyDetectorPropsMixin(props, *, strategy=None)

Bases: Mixin

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.

For more information see Using CloudWatch anomaly detection. .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html
CloudformationResource:: AWS::CloudWatch::AnomalyDetector
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_cloudwatch import mixins as cloudwatch_mixins

cfn_anomaly_detector_props_mixin = cloudwatch_mixins.CfnAnomalyDetectorPropsMixin(cloudwatch_mixins.CfnAnomalyDetectorMixinProps(
    configuration=cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.ConfigurationProperty(
        excluded_time_ranges=[cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.RangeProperty(
            end_time="endTime",
            start_time="startTime"
        )],
        metric_time_zone="metricTimeZone"
    ),
    dimensions=[cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.DimensionProperty(
        name="name",
        value="value"
    )],
    metric_characteristics=cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.MetricCharacteristicsProperty(
        periodic_spikes=False
    ),
    metric_math_anomaly_detector=cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.MetricMathAnomalyDetectorProperty(
        metric_data_queries=[cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.MetricDataQueryProperty(
            account_id="accountId",
            expression="expression",
            id="id",
            label="label",
            metric_stat=cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.MetricStatProperty(
                metric=cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.MetricProperty(
                    dimensions=[cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.DimensionProperty(
                        name="name",
                        value="value"
                    )],
                    metric_name="metricName",
                    namespace="namespace"
                ),
                period=123,
                stat="stat",
                unit="unit"
            ),
            period=123,
            return_data=False
        )]
    ),
    metric_name="metricName",
    namespace="namespace",
    single_metric_anomaly_detector=cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.SingleMetricAnomalyDetectorProperty(
        account_id="accountId",
        dimensions=[cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.DimensionProperty(
            name="name",
            value="value"
        )],
        metric_name="metricName",
        namespace="namespace",
        stat="stat"
    ),
    stat="stat"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::CloudWatch::AnomalyDetector.

Parameters:

props (Union[CfnAnomalyDetectorMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['configuration', 'dimensions', 'metricCharacteristics', 'metricMathAnomalyDetector', 'metricName', 'namespace', 'singleMetricAnomalyDetector', 'stat']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ConfigurationProperty

class CfnAnomalyDetectorPropsMixin.ConfigurationProperty(*, excluded_time_ranges=None, metric_time_zone=None)

Bases: object

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.

Parameters:

excluded_time_ranges (Union[IResolvable, Sequence[Union[IResolvable, RangeProperty, Dict[str, Any]]], None]) – Specifies an array of time ranges to exclude from use when the anomaly detection model is trained and updated. Use this to make sure that events that could cause unusual values for the metric, such as deployments, aren’t used when CloudWatch creates or updates the model.
metric_time_zone (Optional[str]) – The time zone to use for the metric. This is useful to enable the model to automatically account for daylight savings time changes if the metric is sensitive to such time changes. To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, see tz database .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cloudwatch import mixins as cloudwatch_mixins

configuration_property = cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.ConfigurationProperty(
    excluded_time_ranges=[cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.RangeProperty(
        end_time="endTime",
        start_time="startTime"
    )],
    metric_time_zone="metricTimeZone"
)

Attributes

excluded_time_ranges

Specifies an array of time ranges to exclude from use when the anomaly detection model is trained and updated.

Use this to make sure that events that could cause unusual values for the metric, such as deployments, aren’t used when CloudWatch creates or updates the model.

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

metric_time_zone

The time zone to use for the metric.

This is useful to enable the model to automatically account for daylight savings time changes if the metric is sensitive to such time changes.

To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, see tz database .

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

DimensionProperty

class CfnAnomalyDetectorPropsMixin.DimensionProperty(*, name=None, value=None)

Bases: object

A dimension is a name/value pair that is part of the identity of a metric.

Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.

You can assign up to 30 dimensions to a metric.

Parameters:

name (Optional[str]) – The name of the dimension.
value (Optional[str]) – The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cloudwatch import mixins as cloudwatch_mixins

dimension_property = cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.DimensionProperty(
    name="name",
    value="value"
)

Attributes

name

The name of the dimension.

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

value

The value of the dimension.

Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.

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

MetricCharacteristicsProperty

class CfnAnomalyDetectorPropsMixin.MetricCharacteristicsProperty(*, periodic_spikes=None)

Bases: object

This object includes parameters that you can use to provide information to CloudWatch to help it build more accurate anomaly detection models.

Parameters:: periodic_spikes (Union[bool, IResolvable, None]) – Set this parameter to true if values for this metric consistently include spikes that should not be considered to be anomalies. With this set to true, CloudWatch will expect to see spikes that occurred consistently during the model training period, and won’t flag future similar spikes as anomalies.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metriccharacteristics.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cloudwatch import mixins as cloudwatch_mixins

metric_characteristics_property = cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.MetricCharacteristicsProperty(
    periodic_spikes=False
)

Attributes

periodic_spikes

Set this parameter to true if values for this metric consistently include spikes that should not be considered to be anomalies.

With this set to true, CloudWatch will expect to see spikes that occurred consistently during the model training period, and won’t flag future similar spikes as anomalies.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metriccharacteristics.html#cfn-cloudwatch-anomalydetector-metriccharacteristics-periodicspikes

MetricDataQueryProperty

class CfnAnomalyDetectorPropsMixin.MetricDataQueryProperty(*, account_id=None, expression=None, id=None, label=None, metric_stat=None, period=None, return_data=None)

Bases: object

This structure is used in both GetMetricData and PutMetricAlarm .

The supported use of this structure is different for those two operations.

When used in GetMetricData , it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single GetMetricData call can include up to 500 MetricDataQuery structures.

When used in PutMetricAlarm , it enables you to create an alarm based on a metric math expression. Each MetricDataQuery in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm call can include up to 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, one must have true as the value for ReturnData . The result of this expression is the value the alarm watches.

Any expression used in a PutMetricAlarm operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .

Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData operation or a PutMetricAlarm operation. These differences are explained in the following parameter list.

Parameters:

account_id (Optional[str]) – The ID of the account where the metrics are located. If you are performing a GetMetricData operation in a monitoring account, use this to specify which account to retrieve this metric from. If you are performing a PutMetricAlarm operation, use this to specify which account contains the metric that the alarm is watching.
expression (Optional[str]) –
This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide . A math expression can use the Id of the other metrics or queries to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide . Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
id (Optional[str]) – A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData . If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
label (Optional[str]) – A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default. You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels .
metric_stat (Union[IResolvable, MetricStatProperty, Dict[str, Any], None]) – The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data. Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
period (Union[int, float, None]) – The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData operation that includes a StorageResolution of 1 second .
return_data (Union[bool, IResolvable, None]) – When used in GetMetricData , this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify false . If you omit this, the default of true is used. When used in PutMetricAlarm , specify true for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cloudwatch import mixins as cloudwatch_mixins

metric_data_query_property = cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.MetricDataQueryProperty(
    account_id="accountId",
    expression="expression",
    id="id",
    label="label",
    metric_stat=cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.MetricStatProperty(
        metric=cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.MetricProperty(
            dimensions=[cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.DimensionProperty(
                name="name",
                value="value"
            )],
            metric_name="metricName",
            namespace="namespace"
        ),
        period=123,
        stat="stat",
        unit="unit"
    ),
    period=123,
    return_data=False
)

Attributes

account_id

The ID of the account where the metrics are located.

If you are performing a GetMetricData operation in a monitoring account, use this to specify which account to retrieve this metric from.

If you are performing a PutMetricAlarm operation, use this to specify which account contains the metric that the alarm is watching.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-accountid

expression

This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data.

For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide .

A math expression can use the Id of the other metrics or queries to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .

Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

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

id

A short name used to tie this object to the results in the response.

This name must be unique within a single call to GetMetricData . If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

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

label

A human-readable label for this metric or expression.

This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.

You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels .

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

metric_stat

The metric to be returned, along with statistics, period, and units.

Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.

Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

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

period

The granularity, in seconds, of the returned data points.

For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData operation that includes a StorageResolution of 1 second .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html#cfn-cloudwatch-anomalydetector-metricdataquery-period

return_data

When used in GetMetricData , this option indicates whether to return the timestamps and raw data values of this metric.

If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify false . If you omit this, the default of true is used.

When used in PutMetricAlarm , specify true for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.

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

MetricMathAnomalyDetectorProperty

class CfnAnomalyDetectorPropsMixin.MetricMathAnomalyDetectorProperty(*, metric_data_queries=None)

Bases: object

Indicates the CloudWatch math expression that provides the time series the anomaly detector uses as input.

The designated math expression must return a single time series.

Parameters:: metric_data_queries (Union[IResolvable, Sequence[Union[IResolvable, MetricDataQueryProperty, Dict[str, Any]]], None]) – An array of metric data query structures that enables you to create an anomaly detector based on the result of a metric math expression. Each item in MetricDataQueries gets a metric or performs a math expression. One item in MetricDataQueries is the expression that provides the time series that the anomaly detector uses as input. Designate the expression by setting ReturnData to true for this object in the array. For all other expressions and metrics, set ReturnData to false . The designated expression must return a single time series.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricmathanomalydetector.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cloudwatch import mixins as cloudwatch_mixins

metric_math_anomaly_detector_property = cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.MetricMathAnomalyDetectorProperty(
    metric_data_queries=[cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.MetricDataQueryProperty(
        account_id="accountId",
        expression="expression",
        id="id",
        label="label",
        metric_stat=cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.MetricStatProperty(
            metric=cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.MetricProperty(
                dimensions=[cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.DimensionProperty(
                    name="name",
                    value="value"
                )],
                metric_name="metricName",
                namespace="namespace"
            ),
            period=123,
            stat="stat",
            unit="unit"
        ),
        period=123,
        return_data=False
    )]
)

Attributes

metric_data_queries

An array of metric data query structures that enables you to create an anomaly detector based on the result of a metric math expression.

Each item in MetricDataQueries gets a metric or performs a math expression. One item in MetricDataQueries is the expression that provides the time series that the anomaly detector uses as input. Designate the expression by setting ReturnData to true for this object in the array. For all other expressions and metrics, set ReturnData to false . The designated expression must return a single time series.

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

MetricProperty

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

Bases: object

Represents a specific metric.

Parameters:

dimensions (Union[IResolvable, Sequence[Union[IResolvable, DimensionProperty, Dict[str, Any]]], None]) – The dimensions for the metric.
metric_name (Optional[str]) – The name of the metric. This is a required field.
namespace (Optional[str]) – The namespace of the metric.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cloudwatch import mixins as cloudwatch_mixins

metric_property = cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.MetricProperty(
    dimensions=[cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.DimensionProperty(
        name="name",
        value="value"
    )],
    metric_name="metricName",
    namespace="namespace"
)

Attributes

dimensions

The dimensions for the metric.

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

metric_name

The name of the metric.

This is a required field.

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

namespace

The namespace of the metric.

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

MetricStatProperty

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

Bases: object

This structure defines the metric to be returned, along with the statistics, period, and units.

Parameters:

metric (Union[IResolvable, MetricProperty, Dict[str, Any], None]) – The metric to return, including the metric name, namespace, and dimensions.
period (Union[int, float, None]) – The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second. If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned: - Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute). - Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes). - Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
stat (Optional[str]) – The statistic to return. It can include any CloudWatch statistic or extended statistic.
unit (Optional[str]) – When you are using a Put operation, this defines what unit you want to use when storing the metric. In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cloudwatch import mixins as cloudwatch_mixins

metric_stat_property = cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.MetricStatProperty(
    metric=cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.MetricProperty(
        dimensions=[cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.DimensionProperty(
            name="name",
            value="value"
        )],
        metric_name="metricName",
        namespace="namespace"
    ),
    period=123,
    stat="stat",
    unit="unit"
)

Attributes

metric

The metric to return, including the metric name, namespace, and dimensions.

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

period

The granularity, in seconds, of the returned data points.

For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

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

stat

The statistic to return.

It can include any CloudWatch statistic or extended statistic.

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

unit

When you are using a Put operation, this defines what unit you want to use when storing the metric.

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

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

RangeProperty

class CfnAnomalyDetectorPropsMixin.RangeProperty(*, end_time=None, start_time=None)

Bases: object

Each Range specifies one range of days or times to exclude from use for training or updating an anomaly detection model.

Parameters:

end_time (Optional[str]) – The end time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss . For example, 2019-07-01T23:59:59 .
start_time (Optional[str]) – The start time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss . For example, 2019-07-01T23:59:59 .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cloudwatch import mixins as cloudwatch_mixins

range_property = cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.RangeProperty(
    end_time="endTime",
    start_time="startTime"
)

Attributes

end_time

The end time of the range to exclude.

The format is yyyy-MM-dd'T'HH:mm:ss . For example, 2019-07-01T23:59:59 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-range.html#cfn-cloudwatch-anomalydetector-range-endtime

start_time

The start time of the range to exclude.

The format is yyyy-MM-dd'T'HH:mm:ss . For example, 2019-07-01T23:59:59 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-range.html#cfn-cloudwatch-anomalydetector-range-starttime

SingleMetricAnomalyDetectorProperty

class CfnAnomalyDetectorPropsMixin.SingleMetricAnomalyDetectorProperty(*, account_id=None, dimensions=None, metric_name=None, namespace=None, stat=None)

Bases: object

Designates the CloudWatch metric and statistic that provides the time series the anomaly detector uses as input.

If you have enabled unified cross-account observability, and this account is a monitoring account, the metric can be in the same account or a source account.

Parameters:

account_id (Optional[str]) – If the CloudWatch metric that provides the time series that the anomaly detector uses as input is in another account, specify that account ID here. If you omit this parameter, the current account is used.
dimensions (Union[IResolvable, Sequence[Union[IResolvable, DimensionProperty, Dict[str, Any]]], None]) – The metric dimensions to create the anomaly detection model for.
metric_name (Optional[str]) – The name of the metric to create the anomaly detection model for.
namespace (Optional[str]) – The namespace of the metric to create the anomaly detection model for.
stat (Optional[str]) – The statistic to use for the metric and anomaly detection model.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cloudwatch import mixins as cloudwatch_mixins

single_metric_anomaly_detector_property = cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.SingleMetricAnomalyDetectorProperty(
    account_id="accountId",
    dimensions=[cloudwatch_mixins.CfnAnomalyDetectorPropsMixin.DimensionProperty(
        name="name",
        value="value"
    )],
    metric_name="metricName",
    namespace="namespace",
    stat="stat"
)