awslookoutmetrics

package
v1.168.0-devpreview Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 9, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

README

AWS::LookoutMetrics Construct Library

This module is part of the AWS Cloud Development Kit project.

import lookoutmetrics "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::LookoutMetrics.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnAlert_CFN_RESOURCE_TYPE_NAME

func CfnAlert_CFN_RESOURCE_TYPE_NAME() *string

func CfnAlert_IsCfnElement

func CfnAlert_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnAlert_IsCfnResource

func CfnAlert_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnAlert_IsConstruct

func CfnAlert_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnAnomalyDetector_CFN_RESOURCE_TYPE_NAME

func CfnAnomalyDetector_CFN_RESOURCE_TYPE_NAME() *string

func CfnAnomalyDetector_IsCfnElement

func CfnAnomalyDetector_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnAnomalyDetector_IsCfnResource

func CfnAnomalyDetector_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnAnomalyDetector_IsConstruct

func CfnAnomalyDetector_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnAlert_Override

func NewCfnAlert_Override(c CfnAlert, scope awscdk.Construct, id *string, props *CfnAlertProps)

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

func NewCfnAnomalyDetector_Override

func NewCfnAnomalyDetector_Override(c CfnAnomalyDetector, scope awscdk.Construct, id *string, props *CfnAnomalyDetectorProps)

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

Types

type CfnAlert

type CfnAlert interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// Action that will be triggered when there is an alert.
	Action() interface{}
	SetAction(val interface{})
	// A description of the alert.
	AlertDescription() *string
	SetAlertDescription(val *string)
	// The name of the alert.
	AlertName() *string
	SetAlertName(val *string)
	// An integer from 0 to 100 specifying the alert sensitivity threshold.
	AlertSensitivityThreshold() *float64
	SetAlertSensitivityThreshold(val *float64)
	// The ARN of the detector to which the alert is attached.
	AnomalyDetectorArn() *string
	SetAnomalyDetectorArn(val *string)
	// The Amazon Resource Name (ARN) of the alert.
	//
	// For example, `arn:aws:lookoutmetrics:us-east-2:123456789012:Alert:my-alert`.
	AttrArn() *string
	// Options for this resource, such as condition, update policy etc.
	// Experimental.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	// Experimental.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	// Experimental.
	CreationStack() *[]*string
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	// Experimental.
	LogicalId() *string
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	// Experimental.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	// Experimental.
	Stack() awscdk.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	// Experimental.
	UpdatedProperites() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	// Experimental.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	// Experimental.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	// Experimental.
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	// Experimental.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	// Experimental.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	// Experimental.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
	// Experimental.
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	// Experimental.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	// Experimental.
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	// Experimental.
	ShouldSynthesize() *bool
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
	// Experimental.
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::LookoutMetrics::Alert`.

The `AWS::LookoutMetrics::Alert` type creates an alert for an anomaly detector.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnAlert := awscdk.Aws_lookoutmetrics.NewCfnAlert(this, jsii.String("MyCfnAlert"), &cfnAlertProps{
	action: &actionProperty{
		lambdaConfiguration: &lambdaConfigurationProperty{
			lambdaArn: jsii.String("lambdaArn"),
			roleArn: jsii.String("roleArn"),
		},
		snsConfiguration: &sNSConfigurationProperty{
			roleArn: jsii.String("roleArn"),
			snsTopicArn: jsii.String("snsTopicArn"),
		},
	},
	alertSensitivityThreshold: jsii.Number(123),
	anomalyDetectorArn: jsii.String("anomalyDetectorArn"),

	// the properties below are optional
	alertDescription: jsii.String("alertDescription"),
	alertName: jsii.String("alertName"),
})

func NewCfnAlert

func NewCfnAlert(scope awscdk.Construct, id *string, props *CfnAlertProps) CfnAlert

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

type CfnAlertProps

type CfnAlertProps struct {
	// Action that will be triggered when there is an alert.
	Action interface{} `field:"required" json:"action" yaml:"action"`
	// An integer from 0 to 100 specifying the alert sensitivity threshold.
	AlertSensitivityThreshold *float64 `field:"required" json:"alertSensitivityThreshold" yaml:"alertSensitivityThreshold"`
	// The ARN of the detector to which the alert is attached.
	AnomalyDetectorArn *string `field:"required" json:"anomalyDetectorArn" yaml:"anomalyDetectorArn"`
	// A description of the alert.
	AlertDescription *string `field:"optional" json:"alertDescription" yaml:"alertDescription"`
	// The name of the alert.
	AlertName *string `field:"optional" json:"alertName" yaml:"alertName"`
}

Properties for defining a `CfnAlert`.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnAlertProps := &cfnAlertProps{
	action: &actionProperty{
		lambdaConfiguration: &lambdaConfigurationProperty{
			lambdaArn: jsii.String("lambdaArn"),
			roleArn: jsii.String("roleArn"),
		},
		snsConfiguration: &sNSConfigurationProperty{
			roleArn: jsii.String("roleArn"),
			snsTopicArn: jsii.String("snsTopicArn"),
		},
	},
	alertSensitivityThreshold: jsii.Number(123),
	anomalyDetectorArn: jsii.String("anomalyDetectorArn"),

	// the properties below are optional
	alertDescription: jsii.String("alertDescription"),
	alertName: jsii.String("alertName"),
}

type CfnAlert_ActionProperty

type CfnAlert_ActionProperty struct {
	// A configuration for an AWS Lambda channel.
	LambdaConfiguration interface{} `field:"optional" json:"lambdaConfiguration" yaml:"lambdaConfiguration"`
	// A configuration for an Amazon SNS channel.
	SnsConfiguration interface{} `field:"optional" json:"snsConfiguration" yaml:"snsConfiguration"`
}

A configuration that specifies the action to perform when anomalies are detected.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

actionProperty := &actionProperty{
	lambdaConfiguration: &lambdaConfigurationProperty{
		lambdaArn: jsii.String("lambdaArn"),
		roleArn: jsii.String("roleArn"),
	},
	snsConfiguration: &sNSConfigurationProperty{
		roleArn: jsii.String("roleArn"),
		snsTopicArn: jsii.String("snsTopicArn"),
	},
}

type CfnAlert_LambdaConfigurationProperty

type CfnAlert_LambdaConfigurationProperty struct {
	// The ARN of the Lambda function.
	LambdaArn *string `field:"required" json:"lambdaArn" yaml:"lambdaArn"`
	// The ARN of an IAM role that has permission to invoke the Lambda function.
	RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"`
}

Contains information about a Lambda configuration.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

lambdaConfigurationProperty := &lambdaConfigurationProperty{
	lambdaArn: jsii.String("lambdaArn"),
	roleArn: jsii.String("roleArn"),
}

type CfnAlert_SNSConfigurationProperty

type CfnAlert_SNSConfigurationProperty struct {
	// The ARN of the IAM role that has access to the target SNS topic.
	RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"`
	// The ARN of the target SNS topic.
	SnsTopicArn *string `field:"required" json:"snsTopicArn" yaml:"snsTopicArn"`
}

Contains information about the SNS topic to which you want to send your alerts and the IAM role that has access to that topic.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

sNSConfigurationProperty := &sNSConfigurationProperty{
	roleArn: jsii.String("roleArn"),
	snsTopicArn: jsii.String("snsTopicArn"),
}

type CfnAnomalyDetector

type CfnAnomalyDetector interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// Contains information about the configuration of the anomaly detector.
	AnomalyDetectorConfig() interface{}
	SetAnomalyDetectorConfig(val interface{})
	// A description of the detector.
	AnomalyDetectorDescription() *string
	SetAnomalyDetectorDescription(val *string)
	// The name of the detector.
	AnomalyDetectorName() *string
	SetAnomalyDetectorName(val *string)
	// The Amazon Resource Name (ARN) of the detector.
	//
	// For example, `arn:aws:lookoutmetrics:us-east-2:123456789012:AnomalyDetector:my-detector`.
	AttrArn() *string
	// Options for this resource, such as condition, update policy etc.
	// Experimental.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	// Experimental.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	// Experimental.
	CreationStack() *[]*string
	// The ARN of the KMS key to use to encrypt your data.
	KmsKeyArn() *string
	SetKmsKeyArn(val *string)
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	// Experimental.
	LogicalId() *string
	// The detector's dataset.
	MetricSetList() interface{}
	SetMetricSetList(val interface{})
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	// Experimental.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	// Experimental.
	Stack() awscdk.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	// Experimental.
	UpdatedProperites() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	// Experimental.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	// Experimental.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	// Experimental.
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	// Experimental.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	// Experimental.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	// Experimental.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
	// Experimental.
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	// Experimental.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	// Experimental.
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	// Experimental.
	ShouldSynthesize() *bool
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
	// Experimental.
	ValidateProperties(_properties interface{})
}

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 "github.com/aws/aws-cdk-go/awscdk"

cfnAnomalyDetector := awscdk.Aws_lookoutmetrics.NewCfnAnomalyDetector(this, jsii.String("MyCfnAnomalyDetector"), &cfnAnomalyDetectorProps{
	anomalyDetectorConfig: &anomalyDetectorConfigProperty{
		anomalyDetectorFrequency: jsii.String("anomalyDetectorFrequency"),
	},
	metricSetList: []interface{}{
		&metricSetProperty{
			metricList: []interface{}{
				&metricProperty{
					aggregationFunction: jsii.String("aggregationFunction"),
					metricName: jsii.String("metricName"),

					// the properties below are optional
					namespace: jsii.String("namespace"),
				},
			},
			metricSetName: jsii.String("metricSetName"),
			metricSource: &metricSourceProperty{
				appFlowConfig: &appFlowConfigProperty{
					flowName: jsii.String("flowName"),
					roleArn: jsii.String("roleArn"),
				},
				cloudwatchConfig: &cloudwatchConfigProperty{
					roleArn: jsii.String("roleArn"),
				},
				rdsSourceConfig: &rDSSourceConfigProperty{
					databaseHost: jsii.String("databaseHost"),
					databaseName: jsii.String("databaseName"),
					databasePort: jsii.Number(123),
					dbInstanceIdentifier: jsii.String("dbInstanceIdentifier"),
					roleArn: jsii.String("roleArn"),
					secretManagerArn: jsii.String("secretManagerArn"),
					tableName: jsii.String("tableName"),
					vpcConfiguration: &vpcConfigurationProperty{
						securityGroupIdList: []*string{
							jsii.String("securityGroupIdList"),
						},
						subnetIdList: []*string{
							jsii.String("subnetIdList"),
						},
					},
				},
				redshiftSourceConfig: &redshiftSourceConfigProperty{
					clusterIdentifier: jsii.String("clusterIdentifier"),
					databaseHost: jsii.String("databaseHost"),
					databaseName: jsii.String("databaseName"),
					databasePort: jsii.Number(123),
					roleArn: jsii.String("roleArn"),
					secretManagerArn: jsii.String("secretManagerArn"),
					tableName: jsii.String("tableName"),
					vpcConfiguration: &vpcConfigurationProperty{
						securityGroupIdList: []*string{
							jsii.String("securityGroupIdList"),
						},
						subnetIdList: []*string{
							jsii.String("subnetIdList"),
						},
					},
				},
				s3SourceConfig: &s3SourceConfigProperty{
					fileFormatDescriptor: &fileFormatDescriptorProperty{
						csvFormatDescriptor: &csvFormatDescriptorProperty{
							charset: jsii.String("charset"),
							containsHeader: jsii.Boolean(false),
							delimiter: jsii.String("delimiter"),
							fileCompression: jsii.String("fileCompression"),
							headerList: []*string{
								jsii.String("headerList"),
							},
							quoteSymbol: jsii.String("quoteSymbol"),
						},
						jsonFormatDescriptor: &jsonFormatDescriptorProperty{
							charset: jsii.String("charset"),
							fileCompression: jsii.String("fileCompression"),
						},
					},
					roleArn: jsii.String("roleArn"),

					// the properties below are optional
					historicalDataPathList: []*string{
						jsii.String("historicalDataPathList"),
					},
					templatedPathList: []*string{
						jsii.String("templatedPathList"),
					},
				},
			},

			// the properties below are optional
			dimensionList: []*string{
				jsii.String("dimensionList"),
			},
			metricSetDescription: jsii.String("metricSetDescription"),
			metricSetFrequency: jsii.String("metricSetFrequency"),
			offset: jsii.Number(123),
			timestampColumn: &timestampColumnProperty{
				columnFormat: jsii.String("columnFormat"),
				columnName: jsii.String("columnName"),
			},
			timezone: jsii.String("timezone"),
		},
	},

	// the properties below are optional
	anomalyDetectorDescription: jsii.String("anomalyDetectorDescription"),
	anomalyDetectorName: jsii.String("anomalyDetectorName"),
	kmsKeyArn: jsii.String("kmsKeyArn"),
})

func NewCfnAnomalyDetector

func NewCfnAnomalyDetector(scope awscdk.Construct, id *string, props *CfnAnomalyDetectorProps) CfnAnomalyDetector

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

type CfnAnomalyDetectorProps

type CfnAnomalyDetectorProps struct {
	// Contains information about the configuration of the anomaly detector.
	AnomalyDetectorConfig interface{} `field:"required" json:"anomalyDetectorConfig" yaml:"anomalyDetectorConfig"`
	// The detector's dataset.
	MetricSetList interface{} `field:"required" json:"metricSetList" yaml:"metricSetList"`
	// A description of the detector.
	AnomalyDetectorDescription *string `field:"optional" json:"anomalyDetectorDescription" yaml:"anomalyDetectorDescription"`
	// The name of the detector.
	AnomalyDetectorName *string `field:"optional" json:"anomalyDetectorName" yaml:"anomalyDetectorName"`
	// The ARN of the KMS key to use to encrypt your data.
	KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"`
}

Properties for defining a `CfnAnomalyDetector`.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnAnomalyDetectorProps := &cfnAnomalyDetectorProps{
	anomalyDetectorConfig: &anomalyDetectorConfigProperty{
		anomalyDetectorFrequency: jsii.String("anomalyDetectorFrequency"),
	},
	metricSetList: []interface{}{
		&metricSetProperty{
			metricList: []interface{}{
				&metricProperty{
					aggregationFunction: jsii.String("aggregationFunction"),
					metricName: jsii.String("metricName"),

					// the properties below are optional
					namespace: jsii.String("namespace"),
				},
			},
			metricSetName: jsii.String("metricSetName"),
			metricSource: &metricSourceProperty{
				appFlowConfig: &appFlowConfigProperty{
					flowName: jsii.String("flowName"),
					roleArn: jsii.String("roleArn"),
				},
				cloudwatchConfig: &cloudwatchConfigProperty{
					roleArn: jsii.String("roleArn"),
				},
				rdsSourceConfig: &rDSSourceConfigProperty{
					databaseHost: jsii.String("databaseHost"),
					databaseName: jsii.String("databaseName"),
					databasePort: jsii.Number(123),
					dbInstanceIdentifier: jsii.String("dbInstanceIdentifier"),
					roleArn: jsii.String("roleArn"),
					secretManagerArn: jsii.String("secretManagerArn"),
					tableName: jsii.String("tableName"),
					vpcConfiguration: &vpcConfigurationProperty{
						securityGroupIdList: []*string{
							jsii.String("securityGroupIdList"),
						},
						subnetIdList: []*string{
							jsii.String("subnetIdList"),
						},
					},
				},
				redshiftSourceConfig: &redshiftSourceConfigProperty{
					clusterIdentifier: jsii.String("clusterIdentifier"),
					databaseHost: jsii.String("databaseHost"),
					databaseName: jsii.String("databaseName"),
					databasePort: jsii.Number(123),
					roleArn: jsii.String("roleArn"),
					secretManagerArn: jsii.String("secretManagerArn"),
					tableName: jsii.String("tableName"),
					vpcConfiguration: &vpcConfigurationProperty{
						securityGroupIdList: []*string{
							jsii.String("securityGroupIdList"),
						},
						subnetIdList: []*string{
							jsii.String("subnetIdList"),
						},
					},
				},
				s3SourceConfig: &s3SourceConfigProperty{
					fileFormatDescriptor: &fileFormatDescriptorProperty{
						csvFormatDescriptor: &csvFormatDescriptorProperty{
							charset: jsii.String("charset"),
							containsHeader: jsii.Boolean(false),
							delimiter: jsii.String("delimiter"),
							fileCompression: jsii.String("fileCompression"),
							headerList: []*string{
								jsii.String("headerList"),
							},
							quoteSymbol: jsii.String("quoteSymbol"),
						},
						jsonFormatDescriptor: &jsonFormatDescriptorProperty{
							charset: jsii.String("charset"),
							fileCompression: jsii.String("fileCompression"),
						},
					},
					roleArn: jsii.String("roleArn"),

					// the properties below are optional
					historicalDataPathList: []*string{
						jsii.String("historicalDataPathList"),
					},
					templatedPathList: []*string{
						jsii.String("templatedPathList"),
					},
				},
			},

			// the properties below are optional
			dimensionList: []*string{
				jsii.String("dimensionList"),
			},
			metricSetDescription: jsii.String("metricSetDescription"),
			metricSetFrequency: jsii.String("metricSetFrequency"),
			offset: jsii.Number(123),
			timestampColumn: &timestampColumnProperty{
				columnFormat: jsii.String("columnFormat"),
				columnName: jsii.String("columnName"),
			},
			timezone: jsii.String("timezone"),
		},
	},

	// the properties below are optional
	anomalyDetectorDescription: jsii.String("anomalyDetectorDescription"),
	anomalyDetectorName: jsii.String("anomalyDetectorName"),
	kmsKeyArn: jsii.String("kmsKeyArn"),
}

type CfnAnomalyDetector_AnomalyDetectorConfigProperty

type CfnAnomalyDetector_AnomalyDetectorConfigProperty struct {
	// The frequency at which the detector analyzes its source data.
	AnomalyDetectorFrequency *string `field:"required" json:"anomalyDetectorFrequency" yaml:"anomalyDetectorFrequency"`
}

Contains information about a detector's configuration.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

anomalyDetectorConfigProperty := &anomalyDetectorConfigProperty{
	anomalyDetectorFrequency: jsii.String("anomalyDetectorFrequency"),
}

type CfnAnomalyDetector_AppFlowConfigProperty

type CfnAnomalyDetector_AppFlowConfigProperty struct {
	// name of the flow.
	FlowName *string `field:"required" json:"flowName" yaml:"flowName"`
	// An IAM role that gives Amazon Lookout for Metrics permission to access the flow.
	RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"`
}

Details about an Amazon AppFlow flow datasource.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

appFlowConfigProperty := &appFlowConfigProperty{
	flowName: jsii.String("flowName"),
	roleArn: jsii.String("roleArn"),
}

type CfnAnomalyDetector_CloudwatchConfigProperty

type CfnAnomalyDetector_CloudwatchConfigProperty struct {
	// An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.
	RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"`
}

Details about an Amazon CloudWatch datasource.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cloudwatchConfigProperty := &cloudwatchConfigProperty{
	roleArn: jsii.String("roleArn"),
}

type CfnAnomalyDetector_CsvFormatDescriptorProperty

type CfnAnomalyDetector_CsvFormatDescriptorProperty struct {
	// The character set in which the source CSV file is written.
	Charset *string `field:"optional" json:"charset" yaml:"charset"`
	// Whether or not the source CSV file contains a header.
	ContainsHeader interface{} `field:"optional" json:"containsHeader" yaml:"containsHeader"`
	// The character used to delimit the source CSV file.
	Delimiter *string `field:"optional" json:"delimiter" yaml:"delimiter"`
	// The level of compression of the source CSV file.
	FileCompression *string `field:"optional" json:"fileCompression" yaml:"fileCompression"`
	// A list of the source CSV file's headers, if any.
	HeaderList *[]*string `field:"optional" json:"headerList" yaml:"headerList"`
	// The character used as a quote character.
	QuoteSymbol *string `field:"optional" json:"quoteSymbol" yaml:"quoteSymbol"`
}

Contains information about how a source CSV data file should be analyzed.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

csvFormatDescriptorProperty := &csvFormatDescriptorProperty{
	charset: jsii.String("charset"),
	containsHeader: jsii.Boolean(false),
	delimiter: jsii.String("delimiter"),
	fileCompression: jsii.String("fileCompression"),
	headerList: []*string{
		jsii.String("headerList"),
	},
	quoteSymbol: jsii.String("quoteSymbol"),
}

type CfnAnomalyDetector_FileFormatDescriptorProperty

type CfnAnomalyDetector_FileFormatDescriptorProperty struct {
	// Contains information about how a source CSV data file should be analyzed.
	CsvFormatDescriptor interface{} `field:"optional" json:"csvFormatDescriptor" yaml:"csvFormatDescriptor"`
	// Contains information about how a source JSON data file should be analyzed.
	JsonFormatDescriptor interface{} `field:"optional" json:"jsonFormatDescriptor" yaml:"jsonFormatDescriptor"`
}

Contains information about a source file's formatting.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

fileFormatDescriptorProperty := &fileFormatDescriptorProperty{
	csvFormatDescriptor: &csvFormatDescriptorProperty{
		charset: jsii.String("charset"),
		containsHeader: jsii.Boolean(false),
		delimiter: jsii.String("delimiter"),
		fileCompression: jsii.String("fileCompression"),
		headerList: []*string{
			jsii.String("headerList"),
		},
		quoteSymbol: jsii.String("quoteSymbol"),
	},
	jsonFormatDescriptor: &jsonFormatDescriptorProperty{
		charset: jsii.String("charset"),
		fileCompression: jsii.String("fileCompression"),
	},
}

type CfnAnomalyDetector_JsonFormatDescriptorProperty

type CfnAnomalyDetector_JsonFormatDescriptorProperty struct {
	// The character set in which the source JSON file is written.
	Charset *string `field:"optional" json:"charset" yaml:"charset"`
	// The level of compression of the source CSV file.
	FileCompression *string `field:"optional" json:"fileCompression" yaml:"fileCompression"`
}

Contains information about how a source JSON data file should be analyzed.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

jsonFormatDescriptorProperty := &jsonFormatDescriptorProperty{
	charset: jsii.String("charset"),
	fileCompression: jsii.String("fileCompression"),
}

type CfnAnomalyDetector_MetricProperty

type CfnAnomalyDetector_MetricProperty struct {
	// The function with which the metric is calculated.
	AggregationFunction *string `field:"required" json:"aggregationFunction" yaml:"aggregationFunction"`
	// The name of the metric.
	MetricName *string `field:"required" json:"metricName" yaml:"metricName"`
	// The namespace for the metric.
	Namespace *string `field:"optional" json:"namespace" yaml:"namespace"`
}

A calculation made by contrasting a measure and a dimension from your source data.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

metricProperty := &metricProperty{
	aggregationFunction: jsii.String("aggregationFunction"),
	metricName: jsii.String("metricName"),

	// the properties below are optional
	namespace: jsii.String("namespace"),
}

type CfnAnomalyDetector_MetricSetProperty

type CfnAnomalyDetector_MetricSetProperty struct {
	// A list of metrics that the dataset will contain.
	MetricList interface{} `field:"required" json:"metricList" yaml:"metricList"`
	// The name of the dataset.
	MetricSetName *string `field:"required" json:"metricSetName" yaml:"metricSetName"`
	// Contains information about how the source data should be interpreted.
	MetricSource interface{} `field:"required" json:"metricSource" yaml:"metricSource"`
	// A list of the fields you want to treat as dimensions.
	DimensionList *[]*string `field:"optional" json:"dimensionList" yaml:"dimensionList"`
	// A description of the dataset you are creating.
	MetricSetDescription *string `field:"optional" json:"metricSetDescription" yaml:"metricSetDescription"`
	// The frequency with which the source data will be analyzed for anomalies.
	MetricSetFrequency *string `field:"optional" json:"metricSetFrequency" yaml:"metricSetFrequency"`
	// After an interval ends, the amount of seconds that the detector waits before importing data.
	//
	// Offset is only supported for S3 and Redshift datasources.
	Offset *float64 `field:"optional" json:"offset" yaml:"offset"`
	// Contains information about the column used for tracking time in your source data.
	TimestampColumn interface{} `field:"optional" json:"timestampColumn" yaml:"timestampColumn"`
	// The time zone in which your source data was recorded.
	Timezone *string `field:"optional" json:"timezone" yaml:"timezone"`
}

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 "github.com/aws/aws-cdk-go/awscdk"

metricSetProperty := &metricSetProperty{
	metricList: []interface{}{
		&metricProperty{
			aggregationFunction: jsii.String("aggregationFunction"),
			metricName: jsii.String("metricName"),

			// the properties below are optional
			namespace: jsii.String("namespace"),
		},
	},
	metricSetName: jsii.String("metricSetName"),
	metricSource: &metricSourceProperty{
		appFlowConfig: &appFlowConfigProperty{
			flowName: jsii.String("flowName"),
			roleArn: jsii.String("roleArn"),
		},
		cloudwatchConfig: &cloudwatchConfigProperty{
			roleArn: jsii.String("roleArn"),
		},
		rdsSourceConfig: &rDSSourceConfigProperty{
			databaseHost: jsii.String("databaseHost"),
			databaseName: jsii.String("databaseName"),
			databasePort: jsii.Number(123),
			dbInstanceIdentifier: jsii.String("dbInstanceIdentifier"),
			roleArn: jsii.String("roleArn"),
			secretManagerArn: jsii.String("secretManagerArn"),
			tableName: jsii.String("tableName"),
			vpcConfiguration: &vpcConfigurationProperty{
				securityGroupIdList: []*string{
					jsii.String("securityGroupIdList"),
				},
				subnetIdList: []*string{
					jsii.String("subnetIdList"),
				},
			},
		},
		redshiftSourceConfig: &redshiftSourceConfigProperty{
			clusterIdentifier: jsii.String("clusterIdentifier"),
			databaseHost: jsii.String("databaseHost"),
			databaseName: jsii.String("databaseName"),
			databasePort: jsii.Number(123),
			roleArn: jsii.String("roleArn"),
			secretManagerArn: jsii.String("secretManagerArn"),
			tableName: jsii.String("tableName"),
			vpcConfiguration: &vpcConfigurationProperty{
				securityGroupIdList: []*string{
					jsii.String("securityGroupIdList"),
				},
				subnetIdList: []*string{
					jsii.String("subnetIdList"),
				},
			},
		},
		s3SourceConfig: &s3SourceConfigProperty{
			fileFormatDescriptor: &fileFormatDescriptorProperty{
				csvFormatDescriptor: &csvFormatDescriptorProperty{
					charset: jsii.String("charset"),
					containsHeader: jsii.Boolean(false),
					delimiter: jsii.String("delimiter"),
					fileCompression: jsii.String("fileCompression"),
					headerList: []*string{
						jsii.String("headerList"),
					},
					quoteSymbol: jsii.String("quoteSymbol"),
				},
				jsonFormatDescriptor: &jsonFormatDescriptorProperty{
					charset: jsii.String("charset"),
					fileCompression: jsii.String("fileCompression"),
				},
			},
			roleArn: jsii.String("roleArn"),

			// the properties below are optional
			historicalDataPathList: []*string{
				jsii.String("historicalDataPathList"),
			},
			templatedPathList: []*string{
				jsii.String("templatedPathList"),
			},
		},
	},

	// the properties below are optional
	dimensionList: []*string{
		jsii.String("dimensionList"),
	},
	metricSetDescription: jsii.String("metricSetDescription"),
	metricSetFrequency: jsii.String("metricSetFrequency"),
	offset: jsii.Number(123),
	timestampColumn: &timestampColumnProperty{
		columnFormat: jsii.String("columnFormat"),
		columnName: jsii.String("columnName"),
	},
	timezone: jsii.String("timezone"),
}

type CfnAnomalyDetector_MetricSourceProperty

type CfnAnomalyDetector_MetricSourceProperty struct {
	// Details about an AppFlow datasource.
	AppFlowConfig interface{} `field:"optional" json:"appFlowConfig" yaml:"appFlowConfig"`
	// Details about an Amazon CloudWatch monitoring datasource.
	CloudwatchConfig interface{} `field:"optional" json:"cloudwatchConfig" yaml:"cloudwatchConfig"`
	// Details about an Amazon Relational Database Service (RDS) datasource.
	RdsSourceConfig interface{} `field:"optional" json:"rdsSourceConfig" yaml:"rdsSourceConfig"`
	// Details about an Amazon Redshift database datasource.
	RedshiftSourceConfig interface{} `field:"optional" json:"redshiftSourceConfig" yaml:"redshiftSourceConfig"`
	// Contains information about the configuration of the S3 bucket that contains source files.
	S3SourceConfig interface{} `field:"optional" json:"s3SourceConfig" yaml:"s3SourceConfig"`
}

Contains information about how the source data should be interpreted.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

metricSourceProperty := &metricSourceProperty{
	appFlowConfig: &appFlowConfigProperty{
		flowName: jsii.String("flowName"),
		roleArn: jsii.String("roleArn"),
	},
	cloudwatchConfig: &cloudwatchConfigProperty{
		roleArn: jsii.String("roleArn"),
	},
	rdsSourceConfig: &rDSSourceConfigProperty{
		databaseHost: jsii.String("databaseHost"),
		databaseName: jsii.String("databaseName"),
		databasePort: jsii.Number(123),
		dbInstanceIdentifier: jsii.String("dbInstanceIdentifier"),
		roleArn: jsii.String("roleArn"),
		secretManagerArn: jsii.String("secretManagerArn"),
		tableName: jsii.String("tableName"),
		vpcConfiguration: &vpcConfigurationProperty{
			securityGroupIdList: []*string{
				jsii.String("securityGroupIdList"),
			},
			subnetIdList: []*string{
				jsii.String("subnetIdList"),
			},
		},
	},
	redshiftSourceConfig: &redshiftSourceConfigProperty{
		clusterIdentifier: jsii.String("clusterIdentifier"),
		databaseHost: jsii.String("databaseHost"),
		databaseName: jsii.String("databaseName"),
		databasePort: jsii.Number(123),
		roleArn: jsii.String("roleArn"),
		secretManagerArn: jsii.String("secretManagerArn"),
		tableName: jsii.String("tableName"),
		vpcConfiguration: &vpcConfigurationProperty{
			securityGroupIdList: []*string{
				jsii.String("securityGroupIdList"),
			},
			subnetIdList: []*string{
				jsii.String("subnetIdList"),
			},
		},
	},
	s3SourceConfig: &s3SourceConfigProperty{
		fileFormatDescriptor: &fileFormatDescriptorProperty{
			csvFormatDescriptor: &csvFormatDescriptorProperty{
				charset: jsii.String("charset"),
				containsHeader: jsii.Boolean(false),
				delimiter: jsii.String("delimiter"),
				fileCompression: jsii.String("fileCompression"),
				headerList: []*string{
					jsii.String("headerList"),
				},
				quoteSymbol: jsii.String("quoteSymbol"),
			},
			jsonFormatDescriptor: &jsonFormatDescriptorProperty{
				charset: jsii.String("charset"),
				fileCompression: jsii.String("fileCompression"),
			},
		},
		roleArn: jsii.String("roleArn"),

		// the properties below are optional
		historicalDataPathList: []*string{
			jsii.String("historicalDataPathList"),
		},
		templatedPathList: []*string{
			jsii.String("templatedPathList"),
		},
	},
}

type CfnAnomalyDetector_RDSSourceConfigProperty

type CfnAnomalyDetector_RDSSourceConfigProperty struct {
	// The host name of the database.
	DatabaseHost *string `field:"required" json:"databaseHost" yaml:"databaseHost"`
	// The name of the RDS database.
	DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"`
	// The port number where the database can be accessed.
	DatabasePort *float64 `field:"required" json:"databasePort" yaml:"databasePort"`
	// A string identifying the database instance.
	DbInstanceIdentifier *string `field:"required" json:"dbInstanceIdentifier" yaml:"dbInstanceIdentifier"`
	// The Amazon Resource Name (ARN) of the role.
	RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"`
	// The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
	SecretManagerArn *string `field:"required" json:"secretManagerArn" yaml:"secretManagerArn"`
	// The name of the table in the database.
	TableName *string `field:"required" json:"tableName" yaml:"tableName"`
	// An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.
	VpcConfiguration interface{} `field:"required" json:"vpcConfiguration" yaml:"vpcConfiguration"`
}

Contains information about the Amazon Relational Database Service (RDS) configuration.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

rDSSourceConfigProperty := &rDSSourceConfigProperty{
	databaseHost: jsii.String("databaseHost"),
	databaseName: jsii.String("databaseName"),
	databasePort: jsii.Number(123),
	dbInstanceIdentifier: jsii.String("dbInstanceIdentifier"),
	roleArn: jsii.String("roleArn"),
	secretManagerArn: jsii.String("secretManagerArn"),
	tableName: jsii.String("tableName"),
	vpcConfiguration: &vpcConfigurationProperty{
		securityGroupIdList: []*string{
			jsii.String("securityGroupIdList"),
		},
		subnetIdList: []*string{
			jsii.String("subnetIdList"),
		},
	},
}

type CfnAnomalyDetector_RedshiftSourceConfigProperty

type CfnAnomalyDetector_RedshiftSourceConfigProperty struct {
	// A string identifying the Redshift cluster.
	ClusterIdentifier *string `field:"required" json:"clusterIdentifier" yaml:"clusterIdentifier"`
	// The name of the database host.
	DatabaseHost *string `field:"required" json:"databaseHost" yaml:"databaseHost"`
	// The Redshift database name.
	DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"`
	// The port number where the database can be accessed.
	DatabasePort *float64 `field:"required" json:"databasePort" yaml:"databasePort"`
	// The Amazon Resource Name (ARN) of the role providing access to the database.
	RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"`
	// The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
	SecretManagerArn *string `field:"required" json:"secretManagerArn" yaml:"secretManagerArn"`
	// The table name of the Redshift database.
	TableName *string `field:"required" json:"tableName" yaml:"tableName"`
	// Contains information about the Amazon Virtual Private Cloud (VPC) configuration.
	VpcConfiguration interface{} `field:"required" json:"vpcConfiguration" yaml:"vpcConfiguration"`
}

Provides information about the Amazon Redshift database configuration.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

redshiftSourceConfigProperty := &redshiftSourceConfigProperty{
	clusterIdentifier: jsii.String("clusterIdentifier"),
	databaseHost: jsii.String("databaseHost"),
	databaseName: jsii.String("databaseName"),
	databasePort: jsii.Number(123),
	roleArn: jsii.String("roleArn"),
	secretManagerArn: jsii.String("secretManagerArn"),
	tableName: jsii.String("tableName"),
	vpcConfiguration: &vpcConfigurationProperty{
		securityGroupIdList: []*string{
			jsii.String("securityGroupIdList"),
		},
		subnetIdList: []*string{
			jsii.String("subnetIdList"),
		},
	},
}

type CfnAnomalyDetector_S3SourceConfigProperty

type CfnAnomalyDetector_S3SourceConfigProperty struct {
	// Contains information about a source file's formatting.
	FileFormatDescriptor interface{} `field:"required" json:"fileFormatDescriptor" yaml:"fileFormatDescriptor"`
	// The ARN of an IAM role that has read and write access permissions to the source S3 bucket.
	RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"`
	// A list of paths to the historical data files.
	HistoricalDataPathList *[]*string `field:"optional" json:"historicalDataPathList" yaml:"historicalDataPathList"`
	// A list of templated paths to the source files.
	TemplatedPathList *[]*string `field:"optional" json:"templatedPathList" yaml:"templatedPathList"`
}

Contains information about the configuration of the S3 bucket that contains source files.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

s3SourceConfigProperty := &s3SourceConfigProperty{
	fileFormatDescriptor: &fileFormatDescriptorProperty{
		csvFormatDescriptor: &csvFormatDescriptorProperty{
			charset: jsii.String("charset"),
			containsHeader: jsii.Boolean(false),
			delimiter: jsii.String("delimiter"),
			fileCompression: jsii.String("fileCompression"),
			headerList: []*string{
				jsii.String("headerList"),
			},
			quoteSymbol: jsii.String("quoteSymbol"),
		},
		jsonFormatDescriptor: &jsonFormatDescriptorProperty{
			charset: jsii.String("charset"),
			fileCompression: jsii.String("fileCompression"),
		},
	},
	roleArn: jsii.String("roleArn"),

	// the properties below are optional
	historicalDataPathList: []*string{
		jsii.String("historicalDataPathList"),
	},
	templatedPathList: []*string{
		jsii.String("templatedPathList"),
	},
}

type CfnAnomalyDetector_TimestampColumnProperty

type CfnAnomalyDetector_TimestampColumnProperty struct {
	// The format of the timestamp column.
	ColumnFormat *string `field:"optional" json:"columnFormat" yaml:"columnFormat"`
	// The name of the timestamp column.
	ColumnName *string `field:"optional" json:"columnName" yaml:"columnName"`
}

Contains information about the column used to track time in a source data file.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

timestampColumnProperty := &timestampColumnProperty{
	columnFormat: jsii.String("columnFormat"),
	columnName: jsii.String("columnName"),
}

type CfnAnomalyDetector_VpcConfigurationProperty

type CfnAnomalyDetector_VpcConfigurationProperty struct {
	// An array of strings containing the list of security groups.
	SecurityGroupIdList *[]*string `field:"required" json:"securityGroupIdList" yaml:"securityGroupIdList"`
	// An array of strings containing the Amazon VPC subnet IDs (e.g., `subnet-0bb1c79de3EXAMPLE` .
	SubnetIdList *[]*string `field:"required" json:"subnetIdList" yaml:"subnetIdList"`
}

Contains configuration information about the Amazon Virtual Private Cloud (VPC).

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

vpcConfigurationProperty := &vpcConfigurationProperty{
	securityGroupIdList: []*string{
		jsii.String("securityGroupIdList"),
	},
	subnetIdList: []*string{
		jsii.String("subnetIdList"),
	},
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL