interface SubscriptionProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.SNS.SubscriptionProps |
Java | software.amazon.awscdk.services.sns.SubscriptionProps |
Python | aws_cdk.aws_sns.SubscriptionProps |
TypeScript (source) | @aws-cdk/aws-sns » SubscriptionProps |
Properties for creating a new subscription.
Example
import { DeliveryStream } from '@aws-cdk/aws-kinesisfirehose';
const topic = new sns.Topic(this, 'Topic');
declare const stream: DeliveryStream;
new sns.Subscription(this, 'Subscription', {
topic,
endpoint: stream.deliveryStreamArn,
protocol: sns.SubscriptionProtocol.FIREHOSE,
subscriptionRoleArn: "SAMPLE_ARN", //role with permissions to send messages to a firehose delivery stream
});
Properties
Name | Type | Description |
---|---|---|
endpoint | string | The subscription endpoint. |
protocol | Subscription | What type of subscription to add. |
topic | ITopic | The topic to subscribe to. |
dead | IQueue | Queue to be used as dead letter queue. |
filter | { [string]: Subscription } | The filter policy. |
raw | boolean | true if raw message delivery is enabled for the subscription. |
region? | string | The region where the topic resides, in the case of cross-region subscriptions. |
subscription | string | Arn 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:
Subscription
What type of subscription to add.
topic
Type:
ITopic
The topic to subscribe 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]:
Subscription
}
(optional, default: all messages are delivered)
The filter policy.
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.
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.