aws-cdk-lib.aws_sns.CfnTopic.SubscriptionProperty

interface SubscriptionProperty

LanguageType name
.NETAmazon.CDK.AWS.SNS.CfnTopic.SubscriptionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssns#CfnTopic_SubscriptionProperty
Javasoftware.amazon.awscdk.services.sns.CfnTopic.SubscriptionProperty
Pythonaws_cdk.aws_sns.CfnTopic.SubscriptionProperty
TypeScript aws-cdk-lib » aws_sns » CfnTopic » SubscriptionProperty

Subscription is an embedded property that describes the subscription endpoints of an Amazon SNS topic.

For full control over subscription behavior (for example, delivery policy, filtering, raw message delivery, and cross-region subscriptions), use the AWS::SNS::Subscription resource.

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';
const subscriptionProperty: sns.CfnTopic.SubscriptionProperty = {
  endpoint: 'endpoint',
  protocol: 'protocol',
};

Properties

NameTypeDescription
endpointstringThe endpoint that receives notifications from the Amazon SNS topic.
protocolstringThe subscription's protocol.

endpoint

Type: string

The endpoint that receives notifications from the Amazon SNS topic.

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 SNS API Reference .


protocol

Type: string

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 SNS API Reference .