Package software.amazon.awscdk.services.ce

Interface CfnAnomalySubscriptionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnomalySubscriptionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:55.885Z")
@Stability(Stable)
public interface CfnAnomalySubscriptionProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.ce.*;
 CfnAnomalySubscriptionProps cfnAnomalySubscriptionProps = CfnAnomalySubscriptionProps.builder()
         .frequency("frequency")
         .monitorArnList(List.of("monitorArnList"))
         .subscribers(List.of(SubscriberProperty.builder()
                 .address("address")
                 .type("type")
                 // the properties below are optional
                 .status("status")
                 .build()))
         .subscriptionName("subscriptionName")
         // the properties below are optional
         .resourceTags(List.of(ResourceTagProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .threshold(123)
         .thresholdExpression("thresholdExpression")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAnomalySubscriptionProps.Builder	A builder for CfnAnomalySubscriptionProps
static final class	CfnAnomalySubscriptionProps.Jsii$Proxy	An implementation for CfnAnomalySubscriptionProps

Method Summary

Modifier and Type	Method	Description
static CfnAnomalySubscriptionProps.Builder	builder()
String	getFrequency()	The frequency that anomaly notifications are sent.
List<String>	getMonitorArnList()	A list of cost anomaly monitors.
default Object	getResourceTags()	AWS::CE::AnomalySubscription.ResourceTags.
Object	getSubscribers()	A list of subscribers to notify.
String	getSubscriptionName()	The name for the subscription.
default Number	getThreshold()	(deprecated).
default String	getThresholdExpression()	An Expression object in JSON string format used to specify the anomalies that you want to generate alerts for.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFrequency

@Stability(Stable)
@NotNull
String getFrequency()

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 .

getMonitorArnList

@Stability(Stable)
@NotNull
List<String> getMonitorArnList()

A list of cost anomaly monitors.

getSubscribers

@Stability(Stable)
@NotNull
Object getSubscribers()

A list of subscribers to notify.

getSubscriptionName

@Stability(Stable)
@NotNull
String getSubscriptionName()

The name for the subscription.

getResourceTags

@Stability(Stable)
@Nullable
default Object getResourceTags()

AWS::CE::AnomalySubscription.ResourceTags.

getThreshold

@Stability(Stable)
@Nullable
default Number getThreshold()

(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.

getThresholdExpression

@Stability(Stable)
@Nullable
default String getThresholdExpression()

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.

builder

@Stability(Stable)
static CfnAnomalySubscriptionProps.Builder builder()

Returns:

a CfnAnomalySubscriptionProps.Builder of CfnAnomalySubscriptionProps