AWS Native v0.103.0, Apr 22 24

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.lookoutmetrics.AnomalyDetector

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

pulumi/pulumi-aws-native

Create AnomalyDetector Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AnomalyDetector(name: string, args: AnomalyDetectorArgs, opts?: CustomResourceOptions);

@overload
def AnomalyDetector(resource_name: str,
                    args: AnomalyDetectorArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def AnomalyDetector(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    anomaly_detector_config: Optional[AnomalyDetectorConfigArgs] = None,
                    metric_set_list: Optional[Sequence[AnomalyDetectorMetricSetArgs]] = None,
                    anomaly_detector_description: Optional[str] = None,
                    anomaly_detector_name: Optional[str] = None,
                    kms_key_arn: Optional[str] = None)

func NewAnomalyDetector(ctx *Context, name string, args AnomalyDetectorArgs, opts ...ResourceOption) (*AnomalyDetector, error)

public AnomalyDetector(string name, AnomalyDetectorArgs args, CustomResourceOptions? opts = null)

public AnomalyDetector(String name, AnomalyDetectorArgs args)
public AnomalyDetector(String name, AnomalyDetectorArgs args, CustomResourceOptions options)

type: aws-native:lookoutmetrics:AnomalyDetector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args AnomalyDetectorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args AnomalyDetectorArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AnomalyDetectorArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AnomalyDetectorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AnomalyDetectorArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

The following reference example uses placeholder values for all input properties.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const anomalyDetectorResource = new aws_native.lookoutmetrics.AnomalyDetector("anomalyDetectorResource", {
    anomalyDetectorConfig: {
        anomalyDetectorFrequency: aws_native.lookoutmetrics.AnomalyDetectorFrequency.Pt5m,
    },
    metricSetList: [{
        metricList: [{
            aggregationFunction: aws_native.lookoutmetrics.AnomalyDetectorMetricAggregationFunction.Avg,
            metricName: "string",
            namespace: "string",
        }],
        metricSetName: "string",
        metricSource: {
            appFlowConfig: {
                flowName: "string",
                roleArn: "string",
            },
            cloudwatchConfig: {
                roleArn: "string",
            },
            rdsSourceConfig: {
                databaseHost: "string",
                databaseName: "string",
                databasePort: 0,
                dbInstanceIdentifier: "string",
                roleArn: "string",
                secretManagerArn: "string",
                tableName: "string",
                vpcConfiguration: {
                    securityGroupIdList: ["string"],
                    subnetIdList: ["string"],
                },
            },
            redshiftSourceConfig: {
                clusterIdentifier: "string",
                databaseHost: "string",
                databaseName: "string",
                databasePort: 0,
                roleArn: "string",
                secretManagerArn: "string",
                tableName: "string",
                vpcConfiguration: {
                    securityGroupIdList: ["string"],
                    subnetIdList: ["string"],
                },
            },
            s3SourceConfig: {
                fileFormatDescriptor: {
                    csvFormatDescriptor: {
                        charset: "string",
                        containsHeader: false,
                        delimiter: "string",
                        fileCompression: aws_native.lookoutmetrics.AnomalyDetectorCsvFormatDescriptorFileCompression.None,
                        headerList: ["string"],
                        quoteSymbol: "string",
                    },
                    jsonFormatDescriptor: {
                        charset: "string",
                        fileCompression: aws_native.lookoutmetrics.AnomalyDetectorJsonFormatDescriptorFileCompression.None,
                    },
                },
                roleArn: "string",
                historicalDataPathList: ["string"],
                templatedPathList: ["string"],
            },
        },
        dimensionList: ["string"],
        metricSetDescription: "string",
        metricSetFrequency: aws_native.lookoutmetrics.AnomalyDetectorMetricSetMetricSetFrequency.Pt5m,
        offset: 0,
        timestampColumn: {
            columnFormat: "string",
            columnName: "string",
        },
        timezone: "string",
    }],
    anomalyDetectorDescription: "string",
    anomalyDetectorName: "string",
    kmsKeyArn: "string",
});

Coming soon!

AnomalyDetector Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The AnomalyDetector resource accepts the following input properties:

AnomalyDetectorConfig Pulumi.AwsNative.LookoutMetrics.Inputs.AnomalyDetectorConfig: Configuration options for the AnomalyDetector
MetricSetList List<Pulumi.AwsNative.LookoutMetrics.Inputs.AnomalyDetectorMetricSet>: List of metric sets for anomaly detection
AnomalyDetectorDescription string: A description for the AnomalyDetector.
AnomalyDetectorName string: Name for the Amazon Lookout for Metrics Anomaly Detector
KmsKeyArn string: KMS key used to encrypt the AnomalyDetector data

AnomalyDetectorConfig AnomalyDetectorConfigArgs: Configuration options for the AnomalyDetector
MetricSetList []AnomalyDetectorMetricSetArgs: List of metric sets for anomaly detection
AnomalyDetectorDescription string: A description for the AnomalyDetector.
AnomalyDetectorName string: Name for the Amazon Lookout for Metrics Anomaly Detector
KmsKeyArn string: KMS key used to encrypt the AnomalyDetector data

anomalyDetectorConfig AnomalyDetectorConfig: Configuration options for the AnomalyDetector
metricSetList List<AnomalyDetectorMetricSet>: List of metric sets for anomaly detection
anomalyDetectorDescription String: A description for the AnomalyDetector.
anomalyDetectorName String: Name for the Amazon Lookout for Metrics Anomaly Detector
kmsKeyArn String: KMS key used to encrypt the AnomalyDetector data

anomalyDetectorConfig AnomalyDetectorConfig: Configuration options for the AnomalyDetector
metricSetList AnomalyDetectorMetricSet[]: List of metric sets for anomaly detection
anomalyDetectorDescription string: A description for the AnomalyDetector.
anomalyDetectorName string: Name for the Amazon Lookout for Metrics Anomaly Detector
kmsKeyArn string: KMS key used to encrypt the AnomalyDetector data

anomaly_detector_config AnomalyDetectorConfigArgs: Configuration options for the AnomalyDetector
metric_set_list Sequence[AnomalyDetectorMetricSetArgs]: List of metric sets for anomaly detection
anomaly_detector_description str: A description for the AnomalyDetector.
anomaly_detector_name str: Name for the Amazon Lookout for Metrics Anomaly Detector
kms_key_arn str: KMS key used to encrypt the AnomalyDetector data

anomalyDetectorConfig Property Map: Configuration options for the AnomalyDetector
metricSetList List<Property Map>: List of metric sets for anomaly detection
anomalyDetectorDescription String: A description for the AnomalyDetector.
anomalyDetectorName String: Name for the Amazon Lookout for Metrics Anomaly Detector
kmsKeyArn String: KMS key used to encrypt the AnomalyDetector data

Outputs

All input properties are implicitly available as output properties. Additionally, the AnomalyDetector resource produces the following output properties:

Arn string
Id string: The provider-assigned unique ID for this managed resource.

Arn string
Id string: The provider-assigned unique ID for this managed resource.

arn String
id String: The provider-assigned unique ID for this managed resource.

arn string
id string: The provider-assigned unique ID for this managed resource.

arn str
id str: The provider-assigned unique ID for this managed resource.

arn String
id String: The provider-assigned unique ID for this managed resource.

Supporting Types

AnomalyDetectorCsvFormatDescriptorFileCompression, AnomalyDetectorCsvFormatDescriptorFileCompressionArgs

None: NONE
Gzip: GZIP

AnomalyDetectorCsvFormatDescriptorFileCompressionNone: NONE
AnomalyDetectorCsvFormatDescriptorFileCompressionGzip: GZIP

None: NONE
Gzip: GZIP

None: NONE
Gzip: GZIP

NONE: NONE
GZIP: GZIP

"NONE": NONE
"GZIP": GZIP

AnomalyDetectorFileFormatDescriptor, AnomalyDetectorFileFormatDescriptorArgs

CsvFormatDescriptor Pulumi.AwsNative.LookoutMetrics.Inputs.AnomalyDetectorCsvFormatDescriptor
JsonFormatDescriptor Pulumi.AwsNative.LookoutMetrics.Inputs.AnomalyDetectorJsonFormatDescriptor

CsvFormatDescriptor AnomalyDetectorCsvFormatDescriptor
JsonFormatDescriptor AnomalyDetectorJsonFormatDescriptor

csvFormatDescriptor AnomalyDetectorCsvFormatDescriptor
jsonFormatDescriptor AnomalyDetectorJsonFormatDescriptor

csvFormatDescriptor AnomalyDetectorCsvFormatDescriptor
jsonFormatDescriptor AnomalyDetectorJsonFormatDescriptor

csv_format_descriptor AnomalyDetectorCsvFormatDescriptor
json_format_descriptor AnomalyDetectorJsonFormatDescriptor

csvFormatDescriptor Property Map
jsonFormatDescriptor Property Map

AnomalyDetectorFrequency, AnomalyDetectorFrequencyArgs

Pt5m: PT5M
Pt10m: PT10M
Pt1h: PT1H
P1d: P1D

AnomalyDetectorFrequencyPt5m: PT5M
AnomalyDetectorFrequencyPt10m: PT10M
AnomalyDetectorFrequencyPt1h: PT1H
AnomalyDetectorFrequencyP1d: P1D

Pt5m: PT5M
Pt10m: PT10M
Pt1h: PT1H
P1d: P1D

Pt5m: PT5M
Pt10m: PT10M
Pt1h: PT1H
P1d: P1D

PT5M: PT5M
PT10M: PT10M
PT1H: PT1H
P1D: P1D

"PT5M": PT5M
"PT10M": PT10M
"PT1H": PT1H
"P1D": P1D

AnomalyDetectorJsonFormatDescriptor, AnomalyDetectorJsonFormatDescriptorArgs

Charset string
FileCompression Pulumi.AwsNative.LookoutMetrics.AnomalyDetectorJsonFormatDescriptorFileCompression

Charset string
FileCompression AnomalyDetectorJsonFormatDescriptorFileCompression

charset String
fileCompression AnomalyDetectorJsonFormatDescriptorFileCompression

charset string
fileCompression AnomalyDetectorJsonFormatDescriptorFileCompression

charset str
file_compression AnomalyDetectorJsonFormatDescriptorFileCompression

charset String
fileCompression "NONE" | "GZIP"

AnomalyDetectorJsonFormatDescriptorFileCompression, AnomalyDetectorJsonFormatDescriptorFileCompressionArgs

None: NONE
Gzip: GZIP

AnomalyDetectorJsonFormatDescriptorFileCompressionNone: NONE
AnomalyDetectorJsonFormatDescriptorFileCompressionGzip: GZIP

None: NONE
Gzip: GZIP

None: NONE
Gzip: GZIP

NONE: NONE
GZIP: GZIP

"NONE": NONE
"GZIP": GZIP

AnomalyDetectorMetric, AnomalyDetectorMetricArgs

AggregationFunction Pulumi.AwsNative.LookoutMetrics.AnomalyDetectorMetricAggregationFunction: Operator used to aggregate metric values
MetricName string
Namespace string

AggregationFunction AnomalyDetectorMetricAggregationFunction: Operator used to aggregate metric values
MetricName string
Namespace string

aggregationFunction AnomalyDetectorMetricAggregationFunction: Operator used to aggregate metric values
metricName String
namespace String

aggregationFunction AnomalyDetectorMetricAggregationFunction: Operator used to aggregate metric values
metricName string
namespace string

aggregation_function AnomalyDetectorMetricAggregationFunction: Operator used to aggregate metric values
metric_name str
namespace str

aggregationFunction "AVG" | "SUM": Operator used to aggregate metric values
metricName String
namespace String

AnomalyDetectorMetricAggregationFunction, AnomalyDetectorMetricAggregationFunctionArgs

Avg: AVG
Sum: SUM

AnomalyDetectorMetricAggregationFunctionAvg: AVG
AnomalyDetectorMetricAggregationFunctionSum: SUM

Avg: AVG
Sum: SUM

Avg: AVG
Sum: SUM

AVG: AVG
SUM: SUM

"AVG": AVG
"SUM": SUM

AnomalyDetectorMetricSet, AnomalyDetectorMetricSetArgs

MetricList List<Pulumi.AwsNative.LookoutMetrics.Inputs.AnomalyDetectorMetric>: Metrics captured by this MetricSet.
MetricSetName string: The name of the MetricSet.
MetricSource Pulumi.AwsNative.LookoutMetrics.Inputs.AnomalyDetectorMetricSource
DimensionList List<string>: Dimensions for this MetricSet.
MetricSetDescription string: A description for the MetricSet.
MetricSetFrequency Pulumi.AwsNative.LookoutMetrics.AnomalyDetectorMetricSetMetricSetFrequency: A frequency period to aggregate the data
Offset int: Offset, in seconds, between the frequency interval and the time at which the metrics are available.
TimestampColumn Pulumi.AwsNative.LookoutMetrics.Inputs.AnomalyDetectorTimestampColumn
Timezone string

MetricList []AnomalyDetectorMetric: Metrics captured by this MetricSet.
MetricSetName string: The name of the MetricSet.
MetricSource AnomalyDetectorMetricSource
DimensionList []string: Dimensions for this MetricSet.
MetricSetDescription string: A description for the MetricSet.
MetricSetFrequency AnomalyDetectorMetricSetMetricSetFrequency: A frequency period to aggregate the data
Offset int: Offset, in seconds, between the frequency interval and the time at which the metrics are available.
TimestampColumn AnomalyDetectorTimestampColumn
Timezone string

metricList List<AnomalyDetectorMetric>: Metrics captured by this MetricSet.
metricSetName String: The name of the MetricSet.
metricSource AnomalyDetectorMetricSource
dimensionList List<String>: Dimensions for this MetricSet.
metricSetDescription String: A description for the MetricSet.
metricSetFrequency AnomalyDetectorMetricSetMetricSetFrequency: A frequency period to aggregate the data
offset Integer: Offset, in seconds, between the frequency interval and the time at which the metrics are available.
timestampColumn AnomalyDetectorTimestampColumn
timezone String

metricList AnomalyDetectorMetric[]: Metrics captured by this MetricSet.
metricSetName string: The name of the MetricSet.
metricSource AnomalyDetectorMetricSource
dimensionList string[]: Dimensions for this MetricSet.
metricSetDescription string: A description for the MetricSet.
metricSetFrequency AnomalyDetectorMetricSetMetricSetFrequency: A frequency period to aggregate the data
offset number: Offset, in seconds, between the frequency interval and the time at which the metrics are available.
timestampColumn AnomalyDetectorTimestampColumn
timezone string

metric_list Sequence[AnomalyDetectorMetric]: Metrics captured by this MetricSet.
metric_set_name str: The name of the MetricSet.
metric_source AnomalyDetectorMetricSource
dimension_list Sequence[str]: Dimensions for this MetricSet.
metric_set_description str: A description for the MetricSet.
metric_set_frequency AnomalyDetectorMetricSetMetricSetFrequency: A frequency period to aggregate the data
offset int: Offset, in seconds, between the frequency interval and the time at which the metrics are available.
timestamp_column AnomalyDetectorTimestampColumn
timezone str

metricList List<Property Map>: Metrics captured by this MetricSet.
metricSetName String: The name of the MetricSet.
metricSource Property Map
dimensionList List<String>: Dimensions for this MetricSet.
metricSetDescription String: A description for the MetricSet.
metricSetFrequency "PT5M" | "PT10M" | "PT1H" | "P1D": A frequency period to aggregate the data
offset Number: Offset, in seconds, between the frequency interval and the time at which the metrics are available.
timestampColumn Property Map
timezone String