software.amazon.awscdk.services.lookoutmetrics

Interface CfnAnomalyDetectorProps

All Known Implementing Classes:

CfnAnomalyDetectorProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:28:58.899Z")
public interface 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 software.amazon.awscdk.services.lookoutmetrics.*;
 CfnAnomalyDetectorProps cfnAnomalyDetectorProps = CfnAnomalyDetectorProps.builder()
         .anomalyDetectorConfig(AnomalyDetectorConfigProperty.builder()
                 .anomalyDetectorFrequency("anomalyDetectorFrequency")
                 .build())
         .metricSetList(List.of(MetricSetProperty.builder()
                 .metricList(List.of(MetricProperty.builder()
                         .aggregationFunction("aggregationFunction")
                         .metricName("metricName")
                         // the properties below are optional
                         .namespace("namespace")
                         .build()))
                 .metricSetName("metricSetName")
                 .metricSource(MetricSourceProperty.builder()
                         .appFlowConfig(AppFlowConfigProperty.builder()
                                 .flowName("flowName")
                                 .roleArn("roleArn")
                                 .build())
                         .cloudwatchConfig(CloudwatchConfigProperty.builder()
                                 .roleArn("roleArn")
                                 .build())
                         .rdsSourceConfig(RDSSourceConfigProperty.builder()
                                 .databaseHost("databaseHost")
                                 .databaseName("databaseName")
                                 .databasePort(123)
                                 .dbInstanceIdentifier("dbInstanceIdentifier")
                                 .roleArn("roleArn")
                                 .secretManagerArn("secretManagerArn")
                                 .tableName("tableName")
                                 .vpcConfiguration(VpcConfigurationProperty.builder()
                                         .securityGroupIdList(List.of("securityGroupIdList"))
                                         .subnetIdList(List.of("subnetIdList"))
                                         .build())
                                 .build())
                         .redshiftSourceConfig(RedshiftSourceConfigProperty.builder()
                                 .clusterIdentifier("clusterIdentifier")
                                 .databaseHost("databaseHost")
                                 .databaseName("databaseName")
                                 .databasePort(123)
                                 .roleArn("roleArn")
                                 .secretManagerArn("secretManagerArn")
                                 .tableName("tableName")
                                 .vpcConfiguration(VpcConfigurationProperty.builder()
                                         .securityGroupIdList(List.of("securityGroupIdList"))
                                         .subnetIdList(List.of("subnetIdList"))
                                         .build())
                                 .build())
                         .s3SourceConfig(S3SourceConfigProperty.builder()
                                 .fileFormatDescriptor(FileFormatDescriptorProperty.builder()
                                         .csvFormatDescriptor(CsvFormatDescriptorProperty.builder()
                                                 .charset("charset")
                                                 .containsHeader(false)
                                                 .delimiter("delimiter")
                                                 .fileCompression("fileCompression")
                                                 .headerList(List.of("headerList"))
                                                 .quoteSymbol("quoteSymbol")
                                                 .build())
                                         .jsonFormatDescriptor(JsonFormatDescriptorProperty.builder()
                                                 .charset("charset")
                                                 .fileCompression("fileCompression")
                                                 .build())
                                         .build())
                                 .roleArn("roleArn")
                                 // the properties below are optional
                                 .historicalDataPathList(List.of("historicalDataPathList"))
                                 .templatedPathList(List.of("templatedPathList"))
                                 .build())
                         .build())
                 // the properties below are optional
                 .dimensionList(List.of("dimensionList"))
                 .metricSetDescription("metricSetDescription")
                 .metricSetFrequency("metricSetFrequency")
                 .offset(123)
                 .timestampColumn(TimestampColumnProperty.builder()
                         .columnFormat("columnFormat")
                         .columnName("columnName")
                         .build())
                 .timezone("timezone")
                 .build()))
         // the properties below are optional
         .anomalyDetectorDescription("anomalyDetectorDescription")
         .anomalyDetectorName("anomalyDetectorName")
         .kmsKeyArn("kmsKeyArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnAnomalyDetectorProps.Builder A builder for CfnAnomalyDetectorProps
static class	CfnAnomalyDetectorProps.Jsii$Proxy An implementation for CfnAnomalyDetectorProps

Method Summary

Modifier and Type	Method and Description
static CfnAnomalyDetectorProps.Builder	builder()
java.lang.Object	getAnomalyDetectorConfig() Contains information about the configuration of the anomaly detector.
default java.lang.String	getAnomalyDetectorDescription() A description of the detector.
default java.lang.String	getAnomalyDetectorName() The name of the detector.
default java.lang.String	getKmsKeyArn() The ARN of the KMS key to use to encrypt your data.
java.lang.Object	getMetricSetList() The detector's dataset.

Method Detail

getAnomalyDetectorConfig

java.lang.Object getAnomalyDetectorConfig()

Contains information about the configuration of the anomaly detector.

getMetricSetList

java.lang.Object getMetricSetList()

The detector's dataset.

getAnomalyDetectorDescription

default java.lang.String getAnomalyDetectorDescription()

A description of the detector.

getAnomalyDetectorName

default java.lang.String getAnomalyDetectorName()

The name of the detector.

getKmsKeyArn

default java.lang.String getKmsKeyArn()

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

builder

static CfnAnomalyDetectorProps.Builder builder()

Returns:

a CfnAnomalyDetectorProps.Builder of CfnAnomalyDetectorProps