software.amazon.awscdk.services.lookoutmetrics

Class CfnAnomalyDetector

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.lookoutmetrics.CfnAnomalyDetector

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.733Z")
 @Stability(value=Stable)
public class CfnAnomalyDetector
extends CfnResource
implements IInspectable

A CloudFormation `AWS::LookoutMetrics::AnomalyDetector`.

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

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.*;
 CfnAnomalyDetector cfnAnomalyDetector = CfnAnomalyDetector.Builder.create(this, "MyCfnAnomalyDetector")
         .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	Class and Description
static interface	CfnAnomalyDetector.AnomalyDetectorConfigProperty Contains information about a detector's configuration.
static interface	CfnAnomalyDetector.AppFlowConfigProperty Details about an Amazon AppFlow flow datasource.
static class	CfnAnomalyDetector.Builder A fluent builder for CfnAnomalyDetector.
static interface	CfnAnomalyDetector.CloudwatchConfigProperty Details about an Amazon CloudWatch datasource.
static interface	CfnAnomalyDetector.CsvFormatDescriptorProperty Contains information about how a source CSV data file should be analyzed.
static interface	CfnAnomalyDetector.FileFormatDescriptorProperty Contains information about a source file's formatting.
static interface	CfnAnomalyDetector.JsonFormatDescriptorProperty Contains information about how a source JSON data file should be analyzed.
static interface	CfnAnomalyDetector.MetricProperty A calculation made by contrasting a measure and a dimension from your source data.
static interface	CfnAnomalyDetector.MetricSetProperty Contains information about a dataset.
static interface	CfnAnomalyDetector.MetricSourceProperty Contains information about how the source data should be interpreted.
static interface	CfnAnomalyDetector.RDSSourceConfigProperty Contains information about the Amazon Relational Database Service (RDS) configuration.
static interface	CfnAnomalyDetector.RedshiftSourceConfigProperty Provides information about the Amazon Redshift database configuration.
static interface	CfnAnomalyDetector.S3SourceConfigProperty Contains information about the configuration of the S3 bucket that contains source files.
static interface	CfnAnomalyDetector.TimestampColumnProperty Contains information about the column used to track time in a source data file.
static interface	CfnAnomalyDetector.VpcConfigurationProperty Contains configuration information about the Amazon Virtual Private Cloud (VPC).

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAnomalyDetector(software.constructs.Construct scope, String id, CfnAnomalyDetectorProps props) Create a new `AWS::LookoutMetrics::AnomalyDetector`.
protected	CfnAnomalyDetector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAnomalyDetector(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAnomalyDetectorConfig() Contains information about the configuration of the anomaly detector.
String	getAnomalyDetectorDescription() A description of the detector.
String	getAnomalyDetectorName() The name of the detector.
String	getAttrArn() The Amazon Resource Name (ARN) of the detector.
protected Map<String,Object>	getCfnProperties()
String	getKmsKeyArn() The ARN of the KMS key to use to encrypt your data.
Object	getMetricSetList() The detector's dataset.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAnomalyDetectorConfig(CfnAnomalyDetector.AnomalyDetectorConfigProperty value) Contains information about the configuration of the anomaly detector.
void	setAnomalyDetectorConfig(IResolvable value) Contains information about the configuration of the anomaly detector.
void	setAnomalyDetectorDescription(String value) A description of the detector.
void	setAnomalyDetectorName(String value) The name of the detector.
void	setKmsKeyArn(String value) The ARN of the KMS key to use to encrypt your data.
void	setMetricSetList(IResolvable value) The detector's dataset.
void	setMetricSetList(List<Object> value) The detector's dataset.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAnomalyDetector

protected CfnAnomalyDetector(software.amazon.jsii.JsiiObjectRef objRef)

CfnAnomalyDetector

protected CfnAnomalyDetector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAnomalyDetector

@Stability(value=Stable)
public CfnAnomalyDetector(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @NotNull
                                                   CfnAnomalyDetectorProps props)

Create a new `AWS::LookoutMetrics::AnomalyDetector`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the detector.

For example, arn:aws:lookoutmetrics:us-east-2:123456789012:AnomalyDetector:my-detector

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAnomalyDetectorConfig

@Stability(value=Stable)
 @NotNull
public Object getAnomalyDetectorConfig()

Contains information about the configuration of the anomaly detector.

setAnomalyDetectorConfig

@Stability(value=Stable)
public void setAnomalyDetectorConfig(@NotNull
                                                              CfnAnomalyDetector.AnomalyDetectorConfigProperty value)

Contains information about the configuration of the anomaly detector.

setAnomalyDetectorConfig

@Stability(value=Stable)
public void setAnomalyDetectorConfig(@NotNull
                                                              IResolvable value)

Contains information about the configuration of the anomaly detector.

getMetricSetList

@Stability(value=Stable)
 @NotNull
public Object getMetricSetList()

The detector's dataset.

setMetricSetList

@Stability(value=Stable)
public void setMetricSetList(@NotNull
                                                      IResolvable value)

The detector's dataset.

setMetricSetList

@Stability(value=Stable)
public void setMetricSetList(@NotNull
                                                      List<Object> value)

The detector's dataset.

getAnomalyDetectorDescription

@Stability(value=Stable)
 @Nullable
public String getAnomalyDetectorDescription()

A description of the detector.

setAnomalyDetectorDescription

@Stability(value=Stable)
public void setAnomalyDetectorDescription(@Nullable
                                                                   String value)

A description of the detector.

getAnomalyDetectorName

@Stability(value=Stable)
 @Nullable
public String getAnomalyDetectorName()

The name of the detector.

setAnomalyDetectorName

@Stability(value=Stable)
public void setAnomalyDetectorName(@Nullable
                                                            String value)

The name of the detector.

getKmsKeyArn

@Stability(value=Stable)
 @Nullable
public String getKmsKeyArn()

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

setKmsKeyArn

@Stability(value=Stable)
public void setKmsKeyArn(@Nullable
                                                  String value)

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