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.106.0 (build e852934)",
date="2025-02-12T12:32:05.564Z")
@Stability(Stable)
public class CfnAnomalyDetector
extends CfnResource
implements IInspectable
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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
Contains information about a detector's configuration.static interface
Details about an Amazon AppFlow flow datasource.static final class
A fluent builder forCfnAnomalyDetector
.static interface
Details about an Amazon CloudWatch datasource.static interface
Contains information about how a source CSV data file should be analyzed.static interface
Contains information about a source file's formatting.static interface
Contains information about how a source JSON data file should be analyzed.static interface
A calculation made by contrasting a measure and a dimension from your source data.static interface
Contains information about a dataset.static interface
Contains information about how the source data should be interpreted.static interface
Contains information about the Amazon Relational Database Service (RDS) configuration.static interface
Provides information about the Amazon Redshift database configuration.static interface
Contains information about the configuration of the S3 bucket that contains source files.static interface
Contains information about the column used to track time in a source data file.static interface
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.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CfnAnomalyDetector
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnAnomalyDetector
(software.amazon.jsii.JsiiObjectRef objRef) CfnAnomalyDetector
(software.constructs.Construct scope, String id, CfnAnomalyDetectorProps props) -
Method Summary
Modifier and TypeMethodDescriptionContains information about the configuration of the anomaly detector.A description of the detector.The name of the detector.The Amazon Resource Name (ARN) of the detector.The ARN of the KMS key to use to encrypt your data.The detector's dataset.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
Contains information about the configuration of the anomaly detector.void
Contains information about the configuration of the anomaly detector.void
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
(List<Object> value) The detector's dataset.void
setMetricSetList
(IResolvable value) The detector's dataset.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnAnomalyDetectorProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the detector.For example,
arn:aws:lookoutmetrics:us-east-2:123456789012:AnomalyDetector:my-detector
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getAnomalyDetectorConfig
Contains information about the configuration of the anomaly detector. -
setAnomalyDetectorConfig
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
The detector's dataset. -
setMetricSetList
The detector's dataset. -
setMetricSetList
The detector's dataset. -
getAnomalyDetectorDescription
A description of the detector. -
setAnomalyDetectorDescription
A description of the detector. -
getAnomalyDetectorName
The name of the detector. -
setAnomalyDetectorName
The name of the detector. -
getKmsKeyArn
The ARN of the KMS key to use to encrypt your data. -
setKmsKeyArn
The ARN of the KMS key to use to encrypt your data.
-