Package software.amazon.awscdk.services.lookoutmetrics

Class CfnAnomalyDetector

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.lookoutmetrics.CfnAnomalyDetector
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:59.809Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAnomalyDetector

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

    • CfnAnomalyDetector

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

    • CfnAnomalyDetector

      @Stability(Stable) public CfnAnomalyDetector(@NotNull 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 Details

    • inspect

      @Stability(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(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(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAnomalyDetectorConfig

      @Stability(Stable) @NotNull public Object getAnomalyDetectorConfig()
      Contains information about the configuration of the anomaly detector.

    • setAnomalyDetectorConfig

      @Stability(Stable) public void setAnomalyDetectorConfig(@NotNull IResolvable value)
      Contains information about the configuration of the anomaly detector.

    • setAnomalyDetectorConfig

      @Stability(Stable) public void setAnomalyDetectorConfig(@NotNull CfnAnomalyDetector.AnomalyDetectorConfigProperty value)
      Contains information about the configuration of the anomaly detector.

    • getMetricSetList

      @Stability(Stable) @NotNull public Object getMetricSetList()
      The detector's dataset.

    • setMetricSetList

      @Stability(Stable) public void setMetricSetList(@NotNull IResolvable value)
      The detector's dataset.

    • setMetricSetList

      @Stability(Stable) public void setMetricSetList(@NotNull List<Object> value)
      The detector's dataset.

    • getAnomalyDetectorDescription

      @Stability(Stable) @Nullable public String getAnomalyDetectorDescription()
      A description of the detector.

    • setAnomalyDetectorDescription

      @Stability(Stable) public void setAnomalyDetectorDescription(@Nullable String value)
      A description of the detector.

    • getAnomalyDetectorName

      @Stability(Stable) @Nullable public String getAnomalyDetectorName()
      The name of the detector.

    • setAnomalyDetectorName

      @Stability(Stable) public void setAnomalyDetectorName(@Nullable String value)
      The name of the detector.

    • getKmsKeyArn

      @Stability(Stable) @Nullable public String getKmsKeyArn()
      The ARN of the KMS key to use to encrypt your data.

    • setKmsKeyArn

      @Stability(Stable) public void setKmsKeyArn(@Nullable String value)
      The ARN of the KMS key to use to encrypt your data.