awslookoutmetrics

package
v1.146.0-devpreview Latest Latest
Warning

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

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

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() interface{}
	SetAction(val interface{})
	AlertDescription() *string
	SetAlertDescription(val *string)
	AlertName() *string
	SetAlertName(val *string)
	AlertSensitivityThreshold() *float64
	SetAlertSensitivityThreshold(val *float64)
	AnomalyDetectorArn() *string
	SetAnomalyDetectorArn(val *string)
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

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

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

TODO: EXAMPLE

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{} `json:"action" yaml:"action"`
	// An integer from 0 to 100 specifying the alert sensitivity threshold.
	AlertSensitivityThreshold *float64 `json:"alertSensitivityThreshold" yaml:"alertSensitivityThreshold"`
	// The ARN of the detector to which the alert is attached.
	AnomalyDetectorArn *string `json:"anomalyDetectorArn" yaml:"anomalyDetectorArn"`
	// A description of the alert.
	AlertDescription *string `json:"alertDescription" yaml:"alertDescription"`
	// The name of the alert.
	AlertName *string `json:"alertName" yaml:"alertName"`
}

Properties for defining a `CfnAlert`.

TODO: EXAMPLE

type CfnAlert_ActionProperty 

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

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

TODO: EXAMPLE

type CfnAlert_LambdaConfigurationProperty 

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

Contains information about a Lambda configuration.

TODO: EXAMPLE

type CfnAlert_SNSConfigurationProperty 

type CfnAlert_SNSConfigurationProperty struct {
	// The ARN of the IAM role that has access to the target SNS topic.
	RoleArn *string `json:"roleArn" yaml:"roleArn"`
	// The ARN of the target SNS topic.
	SnsTopicArn *string `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.

TODO: EXAMPLE

type CfnAnomalyDetector 

type CfnAnomalyDetector interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AnomalyDetectorConfig() interface{}
	SetAnomalyDetectorConfig(val interface{})
	AnomalyDetectorDescription() *string
	SetAnomalyDetectorDescription(val *string)
	AnomalyDetectorName() *string
	SetAnomalyDetectorName(val *string)
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	KmsKeyArn() *string
	SetKmsKeyArn(val *string)
	LogicalId() *string
	MetricSetList() interface{}
	SetMetricSetList(val interface{})
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

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

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

TODO: EXAMPLE

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{} `json:"anomalyDetectorConfig" yaml:"anomalyDetectorConfig"`
	// The detector's dataset.
	MetricSetList interface{} `json:"metricSetList" yaml:"metricSetList"`
	// A description of the detector.
	AnomalyDetectorDescription *string `json:"anomalyDetectorDescription" yaml:"anomalyDetectorDescription"`
	// The name of the detector.
	AnomalyDetectorName *string `json:"anomalyDetectorName" yaml:"anomalyDetectorName"`
	// The ARN of the KMS key to use to encrypt your data.
	KmsKeyArn *string `json:"kmsKeyArn" yaml:"kmsKeyArn"`
}

Properties for defining a `CfnAnomalyDetector`.

TODO: EXAMPLE

type CfnAnomalyDetector_AnomalyDetectorConfigProperty 

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

Contains information about a detector's configuration.

TODO: EXAMPLE

type CfnAnomalyDetector_AppFlowConfigProperty 

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

Details about an Amazon AppFlow flow datasource.

TODO: EXAMPLE

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 `json:"roleArn" yaml:"roleArn"`
}

Details about an Amazon CloudWatch datasource.

TODO: EXAMPLE

type CfnAnomalyDetector_CsvFormatDescriptorProperty 

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

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

TODO: EXAMPLE

type CfnAnomalyDetector_FileFormatDescriptorProperty 

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

Contains information about a source file's formatting.

TODO: EXAMPLE

type CfnAnomalyDetector_JsonFormatDescriptorProperty 

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

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

TODO: EXAMPLE

type CfnAnomalyDetector_MetricProperty 

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

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

TODO: EXAMPLE

type CfnAnomalyDetector_MetricSetProperty 

type CfnAnomalyDetector_MetricSetProperty struct {
	// A list of metrics that the dataset will contain.
	MetricList interface{} `json:"metricList" yaml:"metricList"`
	// The name of the dataset.
	MetricSetName *string `json:"metricSetName" yaml:"metricSetName"`
	// Contains information about how the source data should be interpreted.
	MetricSource interface{} `json:"metricSource" yaml:"metricSource"`
	// A list of the fields you want to treat as dimensions.
	DimensionList *[]*string `json:"dimensionList" yaml:"dimensionList"`
	// A description of the dataset you are creating.
	MetricSetDescription *string `json:"metricSetDescription" yaml:"metricSetDescription"`
	// The frequency with which the source data will be analyzed for anomalies.
	MetricSetFrequency *string `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 `json:"offset" yaml:"offset"`
	// Contains information about the column used for tracking time in your source data.
	TimestampColumn interface{} `json:"timestampColumn" yaml:"timestampColumn"`
	// The time zone in which your source data was recorded.
	Timezone *string `json:"timezone" yaml:"timezone"`
}

Contains information about a dataset.

TODO: EXAMPLE

type CfnAnomalyDetector_MetricSourceProperty 

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

Contains information about how the source data should be interpreted.

TODO: EXAMPLE

type CfnAnomalyDetector_RDSSourceConfigProperty 

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

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

TODO: EXAMPLE

type CfnAnomalyDetector_RedshiftSourceConfigProperty 

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

Provides information about the Amazon Redshift database configuration.

TODO: EXAMPLE

type CfnAnomalyDetector_S3SourceConfigProperty 

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

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

TODO: EXAMPLE

type CfnAnomalyDetector_TimestampColumnProperty 

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

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

TODO: EXAMPLE

type CfnAnomalyDetector_VpcConfigurationProperty 

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

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

TODO: EXAMPLE

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.