aws-cdk-lib.aws_sns.CfnSubscriptionProps

CfnSubscriptionProps Struct

Properties for defining a CfnSubscription.

CfnSubscriptionProps

used as props by

• CfnSubscription

Source

Generated code

Type last changed

v2.227.0 · 21 Nov 2025

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';

declare const deliveryPolicy: any;
declare const filterPolicy: any;
declare const redrivePolicy: any;
declare const replayPolicy: any;
const cfnSubscriptionProps: sns.CfnSubscriptionProps = {
  protocol: 'protocol',
  topicArn: 'topicArn',

  // the properties below are optional
  deliveryPolicy: deliveryPolicy,
  endpoint: 'endpoint',
  filterPolicy: filterPolicy,
  filterPolicyScope: 'filterPolicyScope',
  rawMessageDelivery: false,
  redrivePolicy: redrivePolicy,
  region: 'region',
  replayPolicy: replayPolicy,
  subscriptionRoleArn: 'subscriptionRoleArn',
};

Properties

deliveryPolicy?optionalanydelivery_policy?optionalAnydeliveryPolicy?optionalObjectDeliveryPolicy?optionalobjectDeliveryPolicy?optionalinterface{}#

The delivery policy JSON assigned to the subscription.

notes

Enables the subscriber to define the message delivery retry strategy in the case of an HTTP/S endpoint subscribed to the topic. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) in the Amazon API Reference and Message delivery retries in the Amazon Developer Guide .

endpoint?optionalstring | IDeliveryStreamRef | IFunctionRef | IVersionRef | IQueueRefendpoint?optionaltyping.Union[str, IDeliveryStreamRef, IFunctionRef, IVersionRef, IQueueRef]endpoint?optionalStringEndpoint?optionalstringEndpoint?optionalinterface{}#

The subscription's endpoint.

The endpoint value depends on the protocol that you specify. For more information, see the Endpoint parameter of the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) action in the Amazon API Reference .

filterPolicy?optionalanyfilter_policy?optionalAnyfilterPolicy?optionalObjectFilterPolicy?optionalobjectFilterPolicy?optionalinterface{}#

The filter policy JSON assigned to the subscription.

notes

Enables the subscriber to filter out unwanted messages. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) in the Amazon API Reference and Message filtering in the Amazon Developer Guide .

filterPolicyScope?optionalstringfilter_policy_scope?optionalstrfilterPolicyScope?optionalStringFilterPolicyScope?optionalstringFilterPolicyScope?optional*string#

This attribute lets you choose the filtering scope by using one of the following string value types:.

notes

• MessageAttributes (default) - The filter is applied on the message attributes.
• MessageBody - The filter is applied on the message body.

Null is not a valid value for FilterPolicyScope . To delete a filter policy, delete the FilterPolicy property but keep FilterPolicyScope property as is.

protocolstringprotocolstrprotocolStringProtocolstringProtocol*stringrequired#

The subscription's protocol.

For more information, see the Protocol parameter of the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) action in the Amazon API Reference .

rawMessageDelivery?optionalboolean | IResolvableraw_message_delivery?optionaltyping.Union[bool, IResolvable]rawMessageDelivery?optionalBooleanRawMessageDelivery?optionalboolRawMessageDelivery?optionalinterface{}#

When set to `true` , enables raw message delivery.

notes

Raw messages don't contain any JSON formatting and can be sent to Amazon SQS and HTTP/S endpoints. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) in the Amazon API Reference .

redrivePolicy?optionalanyredrive_policy?optionalAnyredrivePolicy?optionalObjectRedrivePolicy?optionalobjectRedrivePolicy?optionalinterface{}#

When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue.

notes

Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

For more information about the redrive policy and dead-letter queues, see Amazon SQS dead-letter queues in the Amazon SQS Developer Guide .

region?optionalstringregion?optionalstrregion?optionalStringRegion?optionalstringRegion?optional*string#

For cross-region subscriptions, the region in which the topic resides.

notes

If no region is specified, CloudFormation uses the region of the caller as the default.

If you perform an update operation that only updates the Region property of a AWS::SNS::Subscription resource, that operation will fail unless you are either:

• Updating the Region from NULL to the caller region.
• Updating the Region from the caller region to NULL .

replayPolicy?optionalanyreplay_policy?optionalAnyreplayPolicy?optionalObjectReplayPolicy?optionalobjectReplayPolicy?optionalinterface{}#

Specifies whether Amazon resends the notification to the subscription when a message's attribute changes.

subscriptionRoleArn?optionalstring | IRoleRefsubscription_role_arn?optionaltyping.Union[str, IRoleRef]subscriptionRoleArn?optionalStringSubscriptionRoleArn?optionalstringSubscriptionRoleArn?optionalinterface{}#

This property applies only to Amazon Data Firehose delivery stream subscriptions.

notes

Specify the ARN of the IAM role that has the following:

• Permission to write to the Amazon Data Firehose delivery stream
• Amazon listed as a trusted entity

Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Amazon Data Firehose delivery streams in the Amazon Developer Guide.

topicArnstring | ITopicReftopic_arntyping.Union[str, ITopicRef]topicArnStringTopicArnstringTopicArninterface{}required#

The ARN of the topic to subscribe to.