CfnAnomalyDetectorProps

class aws_cdk.aws_lookoutmetrics.CfnAnomalyDetectorProps(*, anomaly_detector_config, metric_set_list, anomaly_detector_description=None, anomaly_detector_name=None, kms_key_arn=None)

Bases: object

Properties for defining a CfnAnomalyDetector.

Parameters
  • anomaly_detector_config (Union[IResolvable, AnomalyDetectorConfigProperty]) – Contains information about the configuration of the anomaly detector.

  • metric_set_list (Union[IResolvable, Sequence[Union[IResolvable, MetricSetProperty]]]) – The detector’s dataset.

  • anomaly_detector_description (Optional[str]) – A description of the detector.

  • anomaly_detector_name (Optional[str]) – The name of the detector.

  • kms_key_arn (Optional[str]) – The ARN of the KMS key to use to encrypt your data.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_lookoutmetrics as lookoutmetrics

cfn_anomaly_detector_props = lookoutmetrics.CfnAnomalyDetectorProps(
    anomaly_detector_config=lookoutmetrics.CfnAnomalyDetector.AnomalyDetectorConfigProperty(
        anomaly_detector_frequency="anomalyDetectorFrequency"
    ),
    metric_set_list=[lookoutmetrics.CfnAnomalyDetector.MetricSetProperty(
        metric_list=[lookoutmetrics.CfnAnomalyDetector.MetricProperty(
            aggregation_function="aggregationFunction",
            metric_name="metricName",

            # the properties below are optional
            namespace="namespace"
        )],
        metric_set_name="metricSetName",
        metric_source=lookoutmetrics.CfnAnomalyDetector.MetricSourceProperty(
            app_flow_config=lookoutmetrics.CfnAnomalyDetector.AppFlowConfigProperty(
                flow_name="flowName",
                role_arn="roleArn"
            ),
            cloudwatch_config=lookoutmetrics.CfnAnomalyDetector.CloudwatchConfigProperty(
                role_arn="roleArn"
            ),
            rds_source_config=lookoutmetrics.CfnAnomalyDetector.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.CfnAnomalyDetector.VpcConfigurationProperty(
                    security_group_id_list=["securityGroupIdList"],
                    subnet_id_list=["subnetIdList"]
                )
            ),
            redshift_source_config=lookoutmetrics.CfnAnomalyDetector.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.CfnAnomalyDetector.VpcConfigurationProperty(
                    security_group_id_list=["securityGroupIdList"],
                    subnet_id_list=["subnetIdList"]
                )
            ),
            s3_source_config=lookoutmetrics.CfnAnomalyDetector.S3SourceConfigProperty(
                file_format_descriptor=lookoutmetrics.CfnAnomalyDetector.FileFormatDescriptorProperty(
                    csv_format_descriptor=lookoutmetrics.CfnAnomalyDetector.CsvFormatDescriptorProperty(
                        charset="charset",
                        contains_header=False,
                        delimiter="delimiter",
                        file_compression="fileCompression",
                        header_list=["headerList"],
                        quote_symbol="quoteSymbol"
                    ),
                    json_format_descriptor=lookoutmetrics.CfnAnomalyDetector.JsonFormatDescriptorProperty(
                        charset="charset",
                        file_compression="fileCompression"
                    )
                ),
                role_arn="roleArn",

                # the properties below are optional
                historical_data_path_list=["historicalDataPathList"],
                templated_path_list=["templatedPathList"]
            )
        ),

        # the properties below are optional
        dimension_list=["dimensionList"],
        metric_set_description="metricSetDescription",
        metric_set_frequency="metricSetFrequency",
        offset=123,
        timestamp_column=lookoutmetrics.CfnAnomalyDetector.TimestampColumnProperty(
            column_format="columnFormat",
            column_name="columnName"
        ),
        timezone="timezone"
    )],

    # the properties below are optional
    anomaly_detector_description="anomalyDetectorDescription",
    anomaly_detector_name="anomalyDetectorName",
    kms_key_arn="kmsKeyArn"
)

Attributes

anomaly_detector_config

Contains information about the configuration of the anomaly detector.

Link

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

Return type

Union[IResolvable, AnomalyDetectorConfigProperty]

anomaly_detector_description

A description of the detector.

Link

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

Return type

Optional[str]

anomaly_detector_name

The name of the detector.

Link

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

Return type

Optional[str]

kms_key_arn

The ARN of the KMS key to use to encrypt your data.

Link

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

Return type

Optional[str]

metric_set_list

The detector’s dataset.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, MetricSetProperty]]]