aws-cdk-lib.aws_budgets.CfnBudget.SubscriberProperty

interface SubscriberProperty

LanguageType name
.NETAmazon.CDK.AWS.Budgets.CfnBudget.SubscriberProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsbudgets#CfnBudget_SubscriberProperty
Javasoftware.amazon.awscdk.services.budgets.CfnBudget.SubscriberProperty
Pythonaws_cdk.aws_budgets.CfnBudget.SubscriberProperty
TypeScript aws-cdk-lib » aws_budgets » CfnBudget » SubscriberProperty

The Subscriber property type specifies who to notify for a Billing and Cost Management budget notification.

The subscriber consists of a subscription type, and either an Amazon SNS topic or an email address.

For example, an email subscriber would have the following parameters:

  • A subscriptionType of EMAIL
  • An address of example@example.com

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_budgets as budgets } from 'aws-cdk-lib';
const subscriberProperty: budgets.CfnBudget.SubscriberProperty = {
  address: 'address',
  subscriptionType: 'subscriptionType',
};

Properties

NameTypeDescription
addressstringThe address that AWS sends budget notifications to, either an SNS topic or an email.
subscriptionTypestringThe type of notification that AWS sends to a subscriber.

address

Type: string

The address that AWS sends budget notifications to, either an SNS topic or an email.

When you create a subscriber, the value of Address can't contain line breaks.


subscriptionType

Type: string

The type of notification that AWS sends to a subscriber.