interface CfnAnomalyDetectorProps

Language	Type name
.NET	`Amazon.CDK.AWS.LookoutMetrics.CfnAnomalyDetectorProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awslookoutmetrics#CfnAnomalyDetectorProps`
Java	`software.amazon.awscdk.services.lookoutmetrics.CfnAnomalyDetectorProps`
Python	`aws_cdk.aws_lookoutmetrics.CfnAnomalyDetectorProps`
TypeScript	`aws-cdk-lib` » `aws_lookoutmetrics` » `CfnAnomalyDetectorProps`

Properties for defining a CfnAnomalyDetector.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lookoutmetrics as lookoutmetrics } from 'aws-cdk-lib';
const cfnAnomalyDetectorProps: lookoutmetrics.CfnAnomalyDetectorProps = {
  anomalyDetectorConfig: {
    anomalyDetectorFrequency: 'anomalyDetectorFrequency',
  },
  metricSetList: [{
    metricList: [{
      aggregationFunction: 'aggregationFunction',
      metricName: 'metricName',

      // the properties below are optional
      namespace: 'namespace',
    }],
    metricSetName: 'metricSetName',
    metricSource: {
      appFlowConfig: {
        flowName: 'flowName',
        roleArn: 'roleArn',
      },
      cloudwatchConfig: {
        roleArn: 'roleArn',
      },
      rdsSourceConfig: {
        databaseHost: 'databaseHost',
        databaseName: 'databaseName',
        databasePort: 123,
        dbInstanceIdentifier: 'dbInstanceIdentifier',
        roleArn: 'roleArn',
        secretManagerArn: 'secretManagerArn',
        tableName: 'tableName',
        vpcConfiguration: {
          securityGroupIdList: ['securityGroupIdList'],
          subnetIdList: ['subnetIdList'],
        },
      },
      redshiftSourceConfig: {
        clusterIdentifier: 'clusterIdentifier',
        databaseHost: 'databaseHost',
        databaseName: 'databaseName',
        databasePort: 123,
        roleArn: 'roleArn',
        secretManagerArn: 'secretManagerArn',
        tableName: 'tableName',
        vpcConfiguration: {
          securityGroupIdList: ['securityGroupIdList'],
          subnetIdList: ['subnetIdList'],
        },
      },
      s3SourceConfig: {
        fileFormatDescriptor: {
          csvFormatDescriptor: {
            charset: 'charset',
            containsHeader: false,
            delimiter: 'delimiter',
            fileCompression: 'fileCompression',
            headerList: ['headerList'],
            quoteSymbol: 'quoteSymbol',
          },
          jsonFormatDescriptor: {
            charset: 'charset',
            fileCompression: 'fileCompression',
          },
        },
        roleArn: 'roleArn',

        // the properties below are optional
        historicalDataPathList: ['historicalDataPathList'],
        templatedPathList: ['templatedPathList'],
      },
    },

    // the properties below are optional
    dimensionList: ['dimensionList'],
    metricSetDescription: 'metricSetDescription',
    metricSetFrequency: 'metricSetFrequency',
    offset: 123,
    timestampColumn: {
      columnFormat: 'columnFormat',
      columnName: 'columnName',
    },
    timezone: 'timezone',
  }],

  // the properties below are optional
  anomalyDetectorDescription: 'anomalyDetectorDescription',
  anomalyDetectorName: 'anomalyDetectorName',
  kmsKeyArn: 'kmsKeyArn',
};

Properties

Name	Type	Description
anomalyDetectorConfig	`IResolvable` `\|` `AnomalyDetectorConfigProperty`	Contains information about the configuration of the anomaly detector.
metricSetList	`IResolvable` `\|` `IResolvable` `\|` `MetricSetProperty[]`	The detector's dataset.
anomalyDetectorDescription?	`string`	A description of the detector.
anomalyDetectorName?	`string`	The name of the detector.
kmsKeyArn?	`string`	The ARN of the KMS key to use to encrypt your data.

anomalyDetectorConfig

Type: IResolvable | AnomalyDetectorConfigProperty

Contains information about the configuration of the anomaly detector.

metricSetList

Type: IResolvable | IResolvable | MetricSetProperty[]

The detector's dataset.

anomalyDetectorDescription?

Type: string (optional)

A description of the detector.

anomalyDetectorName?

Type: string (optional)

The name of the detector.

kmsKeyArn?

Type: string (optional)

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