aws-cdk-lib.aws_sns.TopicSubscriptionConfig

interface TopicSubscriptionConfig

LanguageType name
.NETAmazon.CDK.AWS.SNS.TopicSubscriptionConfig
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssns#TopicSubscriptionConfig
Javasoftware.amazon.awscdk.services.sns.TopicSubscriptionConfig
Pythonaws_cdk.aws_sns.TopicSubscriptionConfig
TypeScript (source)aws-cdk-lib » aws_sns » TopicSubscriptionConfig

Obtainable from EmailSubscription.bind(), LambdaSubscription.bind(), SmsSubscription.bind(), SqsSubscription.bind(), UrlSubscription.bind()

Subscription configuration.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sns as sns } from 'aws-cdk-lib';
import { aws_sqs as sqs } from 'aws-cdk-lib';
import * as constructs from 'constructs';

declare const construct: constructs.Construct;
declare const dependable: constructs.IDependable;
declare const filterOrPolicy: sns.FilterOrPolicy;
declare const queue: sqs.Queue;
declare const subscriptionFilter: sns.SubscriptionFilter;
const topicSubscriptionConfig: sns.TopicSubscriptionConfig = {
  endpoint: 'endpoint',
  protocol: sns.SubscriptionProtocol.HTTP,
  subscriberId: 'subscriberId',

  // the properties below are optional
  deadLetterQueue: queue,
  filterPolicy: {
    filterPolicyKey: subscriptionFilter,
  },
  filterPolicyWithMessageBody: {
    filterPolicyWithMessageBodyKey: filterOrPolicy,
  },
  rawMessageDelivery: false,
  region: 'region',
  subscriberScope: construct,
  subscriptionDependency: dependable,
  subscriptionRoleArn: 'subscriptionRoleArn',
};

Properties

NameTypeDescription
endpointstringThe subscription endpoint.
protocolSubscriptionProtocolWhat type of subscription to add.
subscriberIdstringThe id of the SNS subscription resource created under scope.
deadLetterQueue?IQueueQueue to be used as dead letter queue.
filterPolicy?{ [string]: SubscriptionFilter }The filter policy.
filterPolicyWithMessageBody?{ [string]: FilterOrPolicy }The filter policy that is applied on the message body.
rawMessageDelivery?booleantrue if raw message delivery is enabled for the subscription.
region?stringThe region where the topic resides, in the case of cross-region subscriptions.
subscriberScope?ConstructThe scope in which to create the SNS subscription resource.
subscriptionDependency?IDependableThe resources that need to be created before the subscription can be safely created.
subscriptionRoleArn?stringArn of role allowing access to firehose delivery stream.

endpoint

Type: string

The subscription endpoint.

The meaning of this value depends on the value for 'protocol'.


protocol

Type: SubscriptionProtocol

What type of subscription to add.


subscriberId

Type: string

The id of the SNS subscription resource created under scope.

In most cases, it is recommended to use the uniqueId of the topic you are subscribing to.


deadLetterQueue?

Type: IQueue (optional, default: No dead letter queue enabled.)

Queue to be used as dead letter queue.

If not passed no dead letter queue is enabled.


filterPolicy?

Type: { [string]: SubscriptionFilter } (optional, default: all messages are delivered)

The filter policy.


filterPolicyWithMessageBody?

Type: { [string]: FilterOrPolicy } (optional, default: all messages are delivered)

The filter policy that is applied on the message body.

To apply a filter policy to the message attributes, use filterPolicy. A maximum of one of filterPolicyWithMessageBody and filterPolicy may be used.


rawMessageDelivery?

Type: boolean (optional, default: false)

true if raw message delivery is enabled for the subscription.

Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints. For more information, see GetSubscriptionAttributes in the Amazon Simple Notification Service API Reference.


region?

Type: string (optional, default: the region where the CloudFormation stack is being deployed.)

The region where the topic resides, in the case of cross-region subscriptions.


subscriberScope?

Type: Construct (optional, default: use the topic as the scope of the subscription, in which case subscriberId must be defined.)

The scope in which to create the SNS subscription resource.

Normally you'd want the subscription to be created on the consuming stack because the topic is usually referenced by the consumer's resource policy (e.g. SQS queue policy). Otherwise, it will cause a cyclic reference.

If this is undefined, the subscription will be created on the topic's stack.


subscriptionDependency?

Type: IDependable (optional, default: empty list)

The resources that need to be created before the subscription can be safely created.

For example for SQS subscription, the subscription needs to have a dependency on the SQS queue policy in order for the subscription to successfully deliver messages.


subscriptionRoleArn?

Type: string (optional, default: No subscription role is provided)

Arn of role allowing access to firehose delivery stream.

Required for a firehose subscription protocol.