CfnAnomalyDetectorPropsMixin

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

Bases: Mixin

End of support notice: On Oct 9, 2025, AWS will end support for Amazon Lookout for Metrics.

After Oct 9, 2025, you will no longer be able to access the Amazon Lookout for Metrics console or Amazon Lookout for Metrics resources. For more information, see Amazon Lookout for Metrics end of support .

The AWS::LookoutMetrics::AnomalyDetector type creates an anomaly detector.

see:

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

cloudformationResource:

AWS::LookoutMetrics::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_lookoutmetrics import mixins as lookoutmetrics_mixins

cfn_anomaly_detector_props_mixin = lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin(lookoutmetrics_mixins.CfnAnomalyDetectorMixinProps(
    anomaly_detector_config=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.AnomalyDetectorConfigProperty(
        anomaly_detector_frequency="anomalyDetectorFrequency"
    ),
    anomaly_detector_description="anomalyDetectorDescription",
    anomaly_detector_name="anomalyDetectorName",
    kms_key_arn="kmsKeyArn",
    metric_set_list=[lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.MetricSetProperty(
        dimension_list=["dimensionList"],
        metric_list=[lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.MetricProperty(
            aggregation_function="aggregationFunction",
            metric_name="metricName",
            namespace="namespace"
        )],
        metric_set_description="metricSetDescription",
        metric_set_frequency="metricSetFrequency",
        metric_set_name="metricSetName",
        metric_source=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.MetricSourceProperty(
            app_flow_config=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.AppFlowConfigProperty(
                flow_name="flowName",
                role_arn="roleArn"
            ),
            cloudwatch_config=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.CloudwatchConfigProperty(
                role_arn="roleArn"
            ),
            rds_source_config=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.RDSSourceConfigProperty(
                database_host="databaseHost",
                database_name="databaseName",
                database_port=123,
                db_instance_identifier="dbInstanceIdentifier",
                role_arn="roleArn",
                secret_manager_arn="secretManagerArn",
                table_name="tableName",
                vpc_configuration=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.VpcConfigurationProperty(
                    security_group_id_list=["securityGroupIdList"],
                    subnet_id_list=["subnetIdList"]
                )
            ),
            redshift_source_config=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.RedshiftSourceConfigProperty(
                cluster_identifier="clusterIdentifier",
                database_host="databaseHost",
                database_name="databaseName",
                database_port=123,
                role_arn="roleArn",
                secret_manager_arn="secretManagerArn",
                table_name="tableName",
                vpc_configuration=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.VpcConfigurationProperty(
                    security_group_id_list=["securityGroupIdList"],
                    subnet_id_list=["subnetIdList"]
                )
            ),
            s3_source_config=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.S3SourceConfigProperty(
                file_format_descriptor=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.FileFormatDescriptorProperty(
                    csv_format_descriptor=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.CsvFormatDescriptorProperty(
                        charset="charset",
                        contains_header=False,
                        delimiter="delimiter",
                        file_compression="fileCompression",
                        header_list=["headerList"],
                        quote_symbol="quoteSymbol"
                    ),
                    json_format_descriptor=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.JsonFormatDescriptorProperty(
                        charset="charset",
                        file_compression="fileCompression"
                    )
                ),
                historical_data_path_list=["historicalDataPathList"],
                role_arn="roleArn",
                templated_path_list=["templatedPathList"]
            )
        ),
        offset=123,
        timestamp_column=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.TimestampColumnProperty(
            column_format="columnFormat",
            column_name="columnName"
        ),
        timezone="timezone"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::LookoutMetrics::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 = ['anomalyDetectorConfig', 'anomalyDetectorDescription', 'anomalyDetectorName', 'kmsKeyArn', 'metricSetList']

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

AnomalyDetectorConfigProperty

class CfnAnomalyDetectorPropsMixin.AnomalyDetectorConfigProperty(*, anomaly_detector_frequency=None)

Bases: object

Contains information about a detector’s configuration.

Parameters:

anomaly_detector_frequency (Optional[str]) – The frequency at which the detector analyzes its source data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-anomalydetectorconfig.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_lookoutmetrics import mixins as lookoutmetrics_mixins

anomaly_detector_config_property = lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.AnomalyDetectorConfigProperty(
    anomaly_detector_frequency="anomalyDetectorFrequency"
)

Attributes

anomaly_detector_frequency

The frequency at which the detector analyzes its source data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-anomalydetectorconfig.html#cfn-lookoutmetrics-anomalydetector-anomalydetectorconfig-anomalydetectorfrequency

AppFlowConfigProperty

class CfnAnomalyDetectorPropsMixin.AppFlowConfigProperty(*, flow_name=None, role_arn=None)

Bases: object

Details about an Amazon AppFlow flow datasource.

Parameters:

• flow_name (Optional[str]) – name of the flow.

• role_arn (Optional[str]) – An IAM role that gives Amazon Lookout for Metrics permission to access the flow.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-appflowconfig.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_lookoutmetrics import mixins as lookoutmetrics_mixins

app_flow_config_property = lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.AppFlowConfigProperty(
    flow_name="flowName",
    role_arn="roleArn"
)

Attributes

flow_name

name of the flow.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-appflowconfig.html#cfn-lookoutmetrics-anomalydetector-appflowconfig-flowname

role_arn

An IAM role that gives Amazon Lookout for Metrics permission to access the flow.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-appflowconfig.html#cfn-lookoutmetrics-anomalydetector-appflowconfig-rolearn

CloudwatchConfigProperty

class CfnAnomalyDetectorPropsMixin.CloudwatchConfigProperty(*, role_arn=None)

Bases: object

Details about an Amazon CloudWatch datasource.

Parameters:

role_arn (Optional[str]) – An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-cloudwatchconfig.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_lookoutmetrics import mixins as lookoutmetrics_mixins

cloudwatch_config_property = lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.CloudwatchConfigProperty(
    role_arn="roleArn"
)

Attributes

role_arn

An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-cloudwatchconfig.html#cfn-lookoutmetrics-anomalydetector-cloudwatchconfig-rolearn

CsvFormatDescriptorProperty

class CfnAnomalyDetectorPropsMixin.CsvFormatDescriptorProperty(*, charset=None, contains_header=None, delimiter=None, file_compression=None, header_list=None, quote_symbol=None)

Bases: object

Contains information about how a source CSV data file should be analyzed.

Parameters:

• charset (Optional[str]) – The character set in which the source CSV file is written.

• contains_header (Union[bool, IResolvable, None]) – Whether or not the source CSV file contains a header.

• delimiter (Optional[str]) – The character used to delimit the source CSV file.

• file_compression (Optional[str]) – The level of compression of the source CSV file.

• header_list (Optional[Sequence[str]]) – A list of the source CSV file’s headers, if any.

• quote_symbol (Optional[str]) – The character used as a quote character.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-csvformatdescriptor.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_lookoutmetrics import mixins as lookoutmetrics_mixins

csv_format_descriptor_property = lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.CsvFormatDescriptorProperty(
    charset="charset",
    contains_header=False,
    delimiter="delimiter",
    file_compression="fileCompression",
    header_list=["headerList"],
    quote_symbol="quoteSymbol"
)

Attributes

charset

The character set in which the source CSV file is written.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-csvformatdescriptor.html#cfn-lookoutmetrics-anomalydetector-csvformatdescriptor-charset

contains_header

Whether or not the source CSV file contains a header.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-csvformatdescriptor.html#cfn-lookoutmetrics-anomalydetector-csvformatdescriptor-containsheader

delimiter

The character used to delimit the source CSV file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-csvformatdescriptor.html#cfn-lookoutmetrics-anomalydetector-csvformatdescriptor-delimiter

file_compression

The level of compression of the source CSV file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-csvformatdescriptor.html#cfn-lookoutmetrics-anomalydetector-csvformatdescriptor-filecompression

header_list

A list of the source CSV file’s headers, if any.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-csvformatdescriptor.html#cfn-lookoutmetrics-anomalydetector-csvformatdescriptor-headerlist

quote_symbol

The character used as a quote character.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-csvformatdescriptor.html#cfn-lookoutmetrics-anomalydetector-csvformatdescriptor-quotesymbol

FileFormatDescriptorProperty

class CfnAnomalyDetectorPropsMixin.FileFormatDescriptorProperty(*, csv_format_descriptor=None, json_format_descriptor=None)

Bases: object

Contains information about a source file’s formatting.

Parameters:

• csv_format_descriptor (Union[IResolvable, CsvFormatDescriptorProperty, Dict[str, Any], None]) – Contains information about how a source CSV data file should be analyzed.

• json_format_descriptor (Union[IResolvable, JsonFormatDescriptorProperty, Dict[str, Any], None]) – Contains information about how a source JSON data file should be analyzed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-fileformatdescriptor.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_lookoutmetrics import mixins as lookoutmetrics_mixins

file_format_descriptor_property = lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.FileFormatDescriptorProperty(
    csv_format_descriptor=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.CsvFormatDescriptorProperty(
        charset="charset",
        contains_header=False,
        delimiter="delimiter",
        file_compression="fileCompression",
        header_list=["headerList"],
        quote_symbol="quoteSymbol"
    ),
    json_format_descriptor=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.JsonFormatDescriptorProperty(
        charset="charset",
        file_compression="fileCompression"
    )
)

Attributes

csv_format_descriptor

Contains information about how a source CSV data file should be analyzed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-fileformatdescriptor.html#cfn-lookoutmetrics-anomalydetector-fileformatdescriptor-csvformatdescriptor

json_format_descriptor

Contains information about how a source JSON data file should be analyzed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-fileformatdescriptor.html#cfn-lookoutmetrics-anomalydetector-fileformatdescriptor-jsonformatdescriptor

JsonFormatDescriptorProperty

class CfnAnomalyDetectorPropsMixin.JsonFormatDescriptorProperty(*, charset=None, file_compression=None)

Bases: object

Contains information about how a source JSON data file should be analyzed.

Parameters:

• charset (Optional[str]) – The character set in which the source JSON file is written.

• file_compression (Optional[str]) – The level of compression of the source CSV file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-jsonformatdescriptor.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_lookoutmetrics import mixins as lookoutmetrics_mixins

json_format_descriptor_property = lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.JsonFormatDescriptorProperty(
    charset="charset",
    file_compression="fileCompression"
)

Attributes

charset

The character set in which the source JSON file is written.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-jsonformatdescriptor.html#cfn-lookoutmetrics-anomalydetector-jsonformatdescriptor-charset

file_compression

The level of compression of the source CSV file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-jsonformatdescriptor.html#cfn-lookoutmetrics-anomalydetector-jsonformatdescriptor-filecompression

MetricProperty

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

Bases: object

A calculation made by contrasting a measure and a dimension from your source data.

Parameters:

• aggregation_function (Optional[str]) – The function with which the metric is calculated.

• metric_name (Optional[str]) – The name of the metric.

• namespace (Optional[str]) – The namespace for the metric.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-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_lookoutmetrics import mixins as lookoutmetrics_mixins

metric_property = lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.MetricProperty(
    aggregation_function="aggregationFunction",
    metric_name="metricName",
    namespace="namespace"
)

Attributes

aggregation_function

The function with which the metric is calculated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metric.html#cfn-lookoutmetrics-anomalydetector-metric-aggregationfunction

metric_name

The name of the metric.

See:

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

namespace

The namespace for the metric.

See:

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

MetricSetProperty

class CfnAnomalyDetectorPropsMixin.MetricSetProperty(*, dimension_list=None, metric_list=None, metric_set_description=None, metric_set_frequency=None, metric_set_name=None, metric_source=None, offset=None, timestamp_column=None, timezone=None)

Bases: object

Contains information about a dataset.

Parameters:

• dimension_list (Optional[Sequence[str]]) – A list of the fields you want to treat as dimensions.

• metric_list (Union[IResolvable, Sequence[Union[IResolvable, MetricProperty, Dict[str, Any]]], None]) – A list of metrics that the dataset will contain.

• metric_set_description (Optional[str]) – A description of the dataset you are creating.

• metric_set_frequency (Optional[str]) – The frequency with which the source data will be analyzed for anomalies.

• metric_set_name (Optional[str]) – The name of the dataset.

• metric_source (Union[IResolvable, MetricSourceProperty, Dict[str, Any], None]) – Contains information about how the source data should be interpreted.

• offset (Union[int, float, None]) – After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.

• timestamp_column (Union[IResolvable, TimestampColumnProperty, Dict[str, Any], None]) – Contains information about the column used for tracking time in your source data.

• timezone (Optional[str]) – The time zone in which your source data was recorded.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricset.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_lookoutmetrics import mixins as lookoutmetrics_mixins

metric_set_property = lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.MetricSetProperty(
    dimension_list=["dimensionList"],
    metric_list=[lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.MetricProperty(
        aggregation_function="aggregationFunction",
        metric_name="metricName",
        namespace="namespace"
    )],
    metric_set_description="metricSetDescription",
    metric_set_frequency="metricSetFrequency",
    metric_set_name="metricSetName",
    metric_source=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.MetricSourceProperty(
        app_flow_config=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.AppFlowConfigProperty(
            flow_name="flowName",
            role_arn="roleArn"
        ),
        cloudwatch_config=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.CloudwatchConfigProperty(
            role_arn="roleArn"
        ),
        rds_source_config=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.RDSSourceConfigProperty(
            database_host="databaseHost",
            database_name="databaseName",
            database_port=123,
            db_instance_identifier="dbInstanceIdentifier",
            role_arn="roleArn",
            secret_manager_arn="secretManagerArn",
            table_name="tableName",
            vpc_configuration=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.VpcConfigurationProperty(
                security_group_id_list=["securityGroupIdList"],
                subnet_id_list=["subnetIdList"]
            )
        ),
        redshift_source_config=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.RedshiftSourceConfigProperty(
            cluster_identifier="clusterIdentifier",
            database_host="databaseHost",
            database_name="databaseName",
            database_port=123,
            role_arn="roleArn",
            secret_manager_arn="secretManagerArn",
            table_name="tableName",
            vpc_configuration=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.VpcConfigurationProperty(
                security_group_id_list=["securityGroupIdList"],
                subnet_id_list=["subnetIdList"]
            )
        ),
        s3_source_config=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.S3SourceConfigProperty(
            file_format_descriptor=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.FileFormatDescriptorProperty(
                csv_format_descriptor=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.CsvFormatDescriptorProperty(
                    charset="charset",
                    contains_header=False,
                    delimiter="delimiter",
                    file_compression="fileCompression",
                    header_list=["headerList"],
                    quote_symbol="quoteSymbol"
                ),
                json_format_descriptor=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.JsonFormatDescriptorProperty(
                    charset="charset",
                    file_compression="fileCompression"
                )
            ),
            historical_data_path_list=["historicalDataPathList"],
            role_arn="roleArn",
            templated_path_list=["templatedPathList"]
        )
    ),
    offset=123,
    timestamp_column=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.TimestampColumnProperty(
        column_format="columnFormat",
        column_name="columnName"
    ),
    timezone="timezone"
)

Attributes

dimension_list

A list of the fields you want to treat as dimensions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricset.html#cfn-lookoutmetrics-anomalydetector-metricset-dimensionlist

metric_list

A list of metrics that the dataset will contain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricset.html#cfn-lookoutmetrics-anomalydetector-metricset-metriclist

metric_set_description

A description of the dataset you are creating.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricset.html#cfn-lookoutmetrics-anomalydetector-metricset-metricsetdescription

metric_set_frequency

The frequency with which the source data will be analyzed for anomalies.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricset.html#cfn-lookoutmetrics-anomalydetector-metricset-metricsetfrequency

metric_set_name

The name of the dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricset.html#cfn-lookoutmetrics-anomalydetector-metricset-metricsetname

metric_source

Contains information about how the source data should be interpreted.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricset.html#cfn-lookoutmetrics-anomalydetector-metricset-metricsource

offset

After an interval ends, the amount of seconds that the detector waits before importing data.

Offset is only supported for S3, Redshift, Athena and datasources.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricset.html#cfn-lookoutmetrics-anomalydetector-metricset-offset

timestamp_column

Contains information about the column used for tracking time in your source data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricset.html#cfn-lookoutmetrics-anomalydetector-metricset-timestampcolumn

timezone

The time zone in which your source data was recorded.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricset.html#cfn-lookoutmetrics-anomalydetector-metricset-timezone

MetricSourceProperty

class CfnAnomalyDetectorPropsMixin.MetricSourceProperty(*, app_flow_config=None, cloudwatch_config=None, rds_source_config=None, redshift_source_config=None, s3_source_config=None)

Bases: object

Contains information about how the source data should be interpreted.

Parameters:

• app_flow_config (Union[IResolvable, AppFlowConfigProperty, Dict[str, Any], None]) – Details about an AppFlow datasource.

• cloudwatch_config (Union[IResolvable, CloudwatchConfigProperty, Dict[str, Any], None]) – Details about an Amazon CloudWatch monitoring datasource.

• rds_source_config (Union[IResolvable, RDSSourceConfigProperty, Dict[str, Any], None]) – Details about an Amazon Relational Database Service (RDS) datasource.

• redshift_source_config (Union[IResolvable, RedshiftSourceConfigProperty, Dict[str, Any], None]) – Details about an Amazon Redshift database datasource.

• s3_source_config (Union[IResolvable, S3SourceConfigProperty, Dict[str, Any], None]) – Contains information about the configuration of the S3 bucket that contains source files.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricsource.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_lookoutmetrics import mixins as lookoutmetrics_mixins

metric_source_property = lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.MetricSourceProperty(
    app_flow_config=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.AppFlowConfigProperty(
        flow_name="flowName",
        role_arn="roleArn"
    ),
    cloudwatch_config=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.CloudwatchConfigProperty(
        role_arn="roleArn"
    ),
    rds_source_config=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.RDSSourceConfigProperty(
        database_host="databaseHost",
        database_name="databaseName",
        database_port=123,
        db_instance_identifier="dbInstanceIdentifier",
        role_arn="roleArn",
        secret_manager_arn="secretManagerArn",
        table_name="tableName",
        vpc_configuration=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.VpcConfigurationProperty(
            security_group_id_list=["securityGroupIdList"],
            subnet_id_list=["subnetIdList"]
        )
    ),
    redshift_source_config=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.RedshiftSourceConfigProperty(
        cluster_identifier="clusterIdentifier",
        database_host="databaseHost",
        database_name="databaseName",
        database_port=123,
        role_arn="roleArn",
        secret_manager_arn="secretManagerArn",
        table_name="tableName",
        vpc_configuration=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.VpcConfigurationProperty(
            security_group_id_list=["securityGroupIdList"],
            subnet_id_list=["subnetIdList"]
        )
    ),
    s3_source_config=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.S3SourceConfigProperty(
        file_format_descriptor=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.FileFormatDescriptorProperty(
            csv_format_descriptor=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.CsvFormatDescriptorProperty(
                charset="charset",
                contains_header=False,
                delimiter="delimiter",
                file_compression="fileCompression",
                header_list=["headerList"],
                quote_symbol="quoteSymbol"
            ),
            json_format_descriptor=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.JsonFormatDescriptorProperty(
                charset="charset",
                file_compression="fileCompression"
            )
        ),
        historical_data_path_list=["historicalDataPathList"],
        role_arn="roleArn",
        templated_path_list=["templatedPathList"]
    )
)

Attributes

app_flow_config

Details about an AppFlow datasource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricsource.html#cfn-lookoutmetrics-anomalydetector-metricsource-appflowconfig

cloudwatch_config

Details about an Amazon CloudWatch monitoring datasource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricsource.html#cfn-lookoutmetrics-anomalydetector-metricsource-cloudwatchconfig

rds_source_config

Details about an Amazon Relational Database Service (RDS) datasource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricsource.html#cfn-lookoutmetrics-anomalydetector-metricsource-rdssourceconfig

redshift_source_config

Details about an Amazon Redshift database datasource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricsource.html#cfn-lookoutmetrics-anomalydetector-metricsource-redshiftsourceconfig

s3_source_config

Contains information about the configuration of the S3 bucket that contains source files.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricsource.html#cfn-lookoutmetrics-anomalydetector-metricsource-s3sourceconfig

RDSSourceConfigProperty

class CfnAnomalyDetectorPropsMixin.RDSSourceConfigProperty(*, database_host=None, database_name=None, database_port=None, db_instance_identifier=None, role_arn=None, secret_manager_arn=None, table_name=None, vpc_configuration=None)

Bases: object

Contains information about the Amazon Relational Database Service (RDS) configuration.

Parameters:

• database_host (Optional[str]) – The host name of the database.

• database_name (Optional[str]) – The name of the RDS database.

• database_port (Union[int, float, None]) – The port number where the database can be accessed.

• db_instance_identifier (Optional[str]) – A string identifying the database instance.

• role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the role.

• secret_manager_arn (Optional[str]) – The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

• table_name (Optional[str]) – The name of the table in the database.

• vpc_configuration (Union[IResolvable, VpcConfigurationProperty, Dict[str, Any], None]) – An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.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_lookoutmetrics import mixins as lookoutmetrics_mixins

r_dSSource_config_property = lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.RDSSourceConfigProperty(
    database_host="databaseHost",
    database_name="databaseName",
    database_port=123,
    db_instance_identifier="dbInstanceIdentifier",
    role_arn="roleArn",
    secret_manager_arn="secretManagerArn",
    table_name="tableName",
    vpc_configuration=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.VpcConfigurationProperty(
        security_group_id_list=["securityGroupIdList"],
        subnet_id_list=["subnetIdList"]
    )
)

Attributes

database_host

The host name of the database.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html#cfn-lookoutmetrics-anomalydetector-rdssourceconfig-databasehost

database_name

The name of the RDS database.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html#cfn-lookoutmetrics-anomalydetector-rdssourceconfig-databasename

database_port

The port number where the database can be accessed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html#cfn-lookoutmetrics-anomalydetector-rdssourceconfig-databaseport

db_instance_identifier

A string identifying the database instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html#cfn-lookoutmetrics-anomalydetector-rdssourceconfig-dbinstanceidentifier

role_arn

The Amazon Resource Name (ARN) of the role.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html#cfn-lookoutmetrics-anomalydetector-rdssourceconfig-rolearn

secret_manager_arn

The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html#cfn-lookoutmetrics-anomalydetector-rdssourceconfig-secretmanagerarn

table_name

The name of the table in the database.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html#cfn-lookoutmetrics-anomalydetector-rdssourceconfig-tablename

vpc_configuration

An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html#cfn-lookoutmetrics-anomalydetector-rdssourceconfig-vpcconfiguration

RedshiftSourceConfigProperty

class CfnAnomalyDetectorPropsMixin.RedshiftSourceConfigProperty(*, cluster_identifier=None, database_host=None, database_name=None, database_port=None, role_arn=None, secret_manager_arn=None, table_name=None, vpc_configuration=None)

Bases: object

Provides information about the Amazon Redshift database configuration.

Parameters:

• cluster_identifier (Optional[str]) – A string identifying the Redshift cluster.

• database_host (Optional[str]) – The name of the database host.

• database_name (Optional[str]) – The Redshift database name.

• database_port (Union[int, float, None]) – The port number where the database can be accessed.

• role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the role providing access to the database.

• secret_manager_arn (Optional[str]) – The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

• table_name (Optional[str]) – The table name of the Redshift database.

• vpc_configuration (Union[IResolvable, VpcConfigurationProperty, Dict[str, Any], None]) – Contains information about the Amazon Virtual Private Cloud (VPC) configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.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_lookoutmetrics import mixins as lookoutmetrics_mixins

redshift_source_config_property = lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.RedshiftSourceConfigProperty(
    cluster_identifier="clusterIdentifier",
    database_host="databaseHost",
    database_name="databaseName",
    database_port=123,
    role_arn="roleArn",
    secret_manager_arn="secretManagerArn",
    table_name="tableName",
    vpc_configuration=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.VpcConfigurationProperty(
        security_group_id_list=["securityGroupIdList"],
        subnet_id_list=["subnetIdList"]
    )
)

Attributes

cluster_identifier

A string identifying the Redshift cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html#cfn-lookoutmetrics-anomalydetector-redshiftsourceconfig-clusteridentifier

database_host

The name of the database host.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html#cfn-lookoutmetrics-anomalydetector-redshiftsourceconfig-databasehost

database_name

The Redshift database name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html#cfn-lookoutmetrics-anomalydetector-redshiftsourceconfig-databasename

database_port

The port number where the database can be accessed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html#cfn-lookoutmetrics-anomalydetector-redshiftsourceconfig-databaseport

role_arn

The Amazon Resource Name (ARN) of the role providing access to the database.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html#cfn-lookoutmetrics-anomalydetector-redshiftsourceconfig-rolearn

secret_manager_arn

The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html#cfn-lookoutmetrics-anomalydetector-redshiftsourceconfig-secretmanagerarn

table_name

The table name of the Redshift database.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html#cfn-lookoutmetrics-anomalydetector-redshiftsourceconfig-tablename

vpc_configuration

Contains information about the Amazon Virtual Private Cloud (VPC) configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html#cfn-lookoutmetrics-anomalydetector-redshiftsourceconfig-vpcconfiguration

S3SourceConfigProperty

class CfnAnomalyDetectorPropsMixin.S3SourceConfigProperty(*, file_format_descriptor=None, historical_data_path_list=None, role_arn=None, templated_path_list=None)

Bases: object

Contains information about the configuration of the S3 bucket that contains source files.

Parameters:

• file_format_descriptor (Union[IResolvable, FileFormatDescriptorProperty, Dict[str, Any], None]) – Contains information about a source file’s formatting.

• historical_data_path_list (Optional[Sequence[str]]) – A list of paths to the historical data files.

• role_arn (Optional[str]) – The ARN of an IAM role that has read and write access permissions to the source S3 bucket.

• templated_path_list (Optional[Sequence[str]]) – A list of templated paths to the source files.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-s3sourceconfig.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_lookoutmetrics import mixins as lookoutmetrics_mixins

s3_source_config_property = lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.S3SourceConfigProperty(
    file_format_descriptor=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.FileFormatDescriptorProperty(
        csv_format_descriptor=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.CsvFormatDescriptorProperty(
            charset="charset",
            contains_header=False,
            delimiter="delimiter",
            file_compression="fileCompression",
            header_list=["headerList"],
            quote_symbol="quoteSymbol"
        ),
        json_format_descriptor=lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.JsonFormatDescriptorProperty(
            charset="charset",
            file_compression="fileCompression"
        )
    ),
    historical_data_path_list=["historicalDataPathList"],
    role_arn="roleArn",
    templated_path_list=["templatedPathList"]
)

Attributes

file_format_descriptor

Contains information about a source file’s formatting.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-s3sourceconfig.html#cfn-lookoutmetrics-anomalydetector-s3sourceconfig-fileformatdescriptor

historical_data_path_list

A list of paths to the historical data files.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-s3sourceconfig.html#cfn-lookoutmetrics-anomalydetector-s3sourceconfig-historicaldatapathlist

role_arn

The ARN of an IAM role that has read and write access permissions to the source S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-s3sourceconfig.html#cfn-lookoutmetrics-anomalydetector-s3sourceconfig-rolearn

templated_path_list

A list of templated paths to the source files.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-s3sourceconfig.html#cfn-lookoutmetrics-anomalydetector-s3sourceconfig-templatedpathlist

TimestampColumnProperty

class CfnAnomalyDetectorPropsMixin.TimestampColumnProperty(*, column_format=None, column_name=None)

Bases: object

Contains information about the column used to track time in a source data file.

Parameters:

• column_format (Optional[str]) – The format of the timestamp column.

• column_name (Optional[str]) – The name of the timestamp column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-timestampcolumn.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_lookoutmetrics import mixins as lookoutmetrics_mixins

timestamp_column_property = lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.TimestampColumnProperty(
    column_format="columnFormat",
    column_name="columnName"
)

Attributes

column_format

The format of the timestamp column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-timestampcolumn.html#cfn-lookoutmetrics-anomalydetector-timestampcolumn-columnformat

column_name

The name of the timestamp column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-timestampcolumn.html#cfn-lookoutmetrics-anomalydetector-timestampcolumn-columnname

VpcConfigurationProperty

class CfnAnomalyDetectorPropsMixin.VpcConfigurationProperty(*, security_group_id_list=None, subnet_id_list=None)

Bases: object

Contains configuration information about the Amazon Virtual Private Cloud (VPC).

Parameters:

• security_group_id_list (Optional[Sequence[str]]) – An array of strings containing the list of security groups.

• subnet_id_list (Optional[Sequence[str]]) – An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-vpcconfiguration.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_lookoutmetrics import mixins as lookoutmetrics_mixins

vpc_configuration_property = lookoutmetrics_mixins.CfnAnomalyDetectorPropsMixin.VpcConfigurationProperty(
    security_group_id_list=["securityGroupIdList"],
    subnet_id_list=["subnetIdList"]
)

Attributes

security_group_id_list

An array of strings containing the list of security groups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-vpcconfiguration.html#cfn-lookoutmetrics-anomalydetector-vpcconfiguration-securitygroupidlist

subnet_id_list

An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-vpcconfiguration.html#cfn-lookoutmetrics-anomalydetector-vpcconfiguration-subnetidlist