aws-cdk-lib.aws_ce.CfnAnomalySubscriptionProps

interface CfnAnomalySubscriptionProps

LanguageType name
.NETAmazon.CDK.AWS.CE.CfnAnomalySubscriptionProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsce#CfnAnomalySubscriptionProps
Javasoftware.amazon.awscdk.services.ce.CfnAnomalySubscriptionProps
Pythonaws_cdk.aws_ce.CfnAnomalySubscriptionProps
TypeScript aws-cdk-lib » aws_ce » CfnAnomalySubscriptionProps

Properties for defining a CfnAnomalySubscription.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ce as ce } from 'aws-cdk-lib';
const cfnAnomalySubscriptionProps: ce.CfnAnomalySubscriptionProps = {
  frequency: 'frequency',
  monitorArnList: ['monitorArnList'],
  subscribers: [{
    address: 'address',
    type: 'type',

    // the properties below are optional
    status: 'status',
  }],
  subscriptionName: 'subscriptionName',

  // the properties below are optional
  resourceTags: [{
    key: 'key',
    value: 'value',
  }],
  threshold: 123,
  thresholdExpression: 'thresholdExpression',
};

Properties

NameTypeDescription
frequencystringThe frequency that anomaly notifications are sent.
monitorArnListstring[]A list of cost anomaly monitors.
subscribersIResolvable | IResolvable | SubscriberProperty[]A list of subscribers to notify.
subscriptionNamestringThe name for the subscription.
resourceTags?IResolvable | IResolvable | ResourceTagProperty[]AWS::CE::AnomalySubscription.ResourceTags.
threshold?number(deprecated).
thresholdExpression?stringAn Expression object in JSON string format used to specify the anomalies that you want to generate alerts for. This supports dimensions and nested expressions. The supported dimensions are ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE , corresponding to an anomaly’s TotalImpact and TotalImpactPercentage, respectively (see Impact for more details). The supported nested expression types are AND and OR . The match option GREATER_THAN_OR_EQUAL is required. Values must be numbers between 0 and 10,000,000,000 in string format.

frequency

Type: string

The frequency that anomaly notifications are sent.

Notifications are sent either over email (for DAILY and WEEKLY frequencies) or SNS (for IMMEDIATE frequency). For more information, see Creating an Amazon SNS topic for anomaly notifications .


monitorArnList

Type: string[]

A list of cost anomaly monitors.


subscribers

Type: IResolvable | IResolvable | SubscriberProperty[]

A list of subscribers to notify.


subscriptionName

Type: string

The name for the subscription.


resourceTags?

Type: IResolvable | IResolvable | ResourceTagProperty[] (optional)

AWS::CE::AnomalySubscription.ResourceTags.


threshold?

Type: number (optional)

(deprecated).

An absolute dollar value that must be exceeded by the anomaly's total impact (see Impact for more details) for an anomaly notification to be generated.

This field has been deprecated. To specify a threshold, use ThresholdExpression. Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression.

One of Threshold or ThresholdExpression is required for AWS::CE::AnomalySubscription . You cannot specify both.


thresholdExpression?

Type: string (optional)

An Expression object in JSON string format used to specify the anomalies that you want to generate alerts for. This supports dimensions and nested expressions. The supported dimensions are ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE , corresponding to an anomaly’s TotalImpact and TotalImpactPercentage, respectively (see Impact for more details). The supported nested expression types are AND and OR . The match option GREATER_THAN_OR_EQUAL is required. Values must be numbers between 0 and 10,000,000,000 in string format.

One of Threshold or ThresholdExpression is required for AWS::CE::AnomalySubscription . You cannot specify both.

For further information, see the Examples section of this page.