Package software.amazon.awscdk.services.lookoutmetrics

Interface CfnAnomalyDetector.MetricSetProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnomalyDetector.MetricSetProperty.Jsii$Proxy

Enclosing class:

CfnAnomalyDetector

@Stability(Stable)
public static interface CfnAnomalyDetector.MetricSetProperty
extends software.amazon.jsii.JsiiSerializable

Contains information about a dataset.

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.*;
 MetricSetProperty metricSetProperty = 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAnomalyDetector.MetricSetProperty.Builder	builder()
default List<String>	getDimensionList()	A list of the fields you want to treat as dimensions.
Object	getMetricList()	A list of metrics that the dataset will contain.
default String	getMetricSetDescription()	A description of the dataset you are creating.
default String	getMetricSetFrequency()	The frequency with which the source data will be analyzed for anomalies.
String	getMetricSetName()	The name of the dataset.
Object	getMetricSource()	Contains information about how the source data should be interpreted.
default Number	getOffset()	After an interval ends, the amount of seconds that the detector waits before importing data.
default Object	getTimestampColumn()	Contains information about the column used for tracking time in your source data.
default String	getTimezone()	The time zone in which your source data was recorded.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMetricList

@Stability(Stable)
@NotNull
Object getMetricList()

A list of metrics that the dataset will contain.

getMetricSetName

@Stability(Stable)
@NotNull
String getMetricSetName()

The name of the dataset.

getMetricSource

@Stability(Stable)
@NotNull
Object getMetricSource()

Contains information about how the source data should be interpreted.

getDimensionList

@Stability(Stable)
@Nullable
default List<String> getDimensionList()

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

getMetricSetDescription

@Stability(Stable)
@Nullable
default String getMetricSetDescription()

A description of the dataset you are creating.

getMetricSetFrequency

@Stability(Stable)
@Nullable
default String getMetricSetFrequency()

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

getOffset

@Stability(Stable)
@Nullable
default Number getOffset()

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.

getTimestampColumn

@Stability(Stable)
@Nullable
default Object getTimestampColumn()

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

getTimezone

@Stability(Stable)
@Nullable
default String getTimezone()

The time zone in which your source data was recorded.

builder

@Stability(Stable)
static CfnAnomalyDetector.MetricSetProperty.Builder builder()

Returns:

a CfnAnomalyDetector.MetricSetProperty.Builder of CfnAnomalyDetector.MetricSetProperty