class Subscription (construct)
A new subscription.
Prefer to use the
ITopic.addSubscription() methods to create instances of
new Subscription(scope: Construct, id: string, props: SubscriptionProps)
|endpoint||The subscription endpoint.|
|protocol||What type of subscription to add.|
|topic||The topic to subscribe to.|
|dead||Queue to be used as dead letter queue.|
|filter||The filter policy.|
|raw||true if raw message delivery is enabled for the subscription.|
|region?||The region where the topic resides, in the case of cross-region subscriptions.|
The subscription endpoint.
The meaning of this value depends on the value for 'protocol'.
What type of subscription to add.
The topic to subscribe to.
(optional, default: No dead letter queue enabled.)
Queue to be used as dead letter queue.
If not passed no dead letter queue is enabled.
(optional, default: all messages are delivered)
The filter policy.
(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.
(optional, default: the region where the CloudFormation stack is being deployed.)
The region where the topic resides, in the case of cross-region subscriptions.
|env||The environment this resource belongs to.|
|node||The construct tree node associated with this construct.|
|stack||The stack in which this resource is defined.|
|dead||The DLQ associated with this subscription if present.|
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
The construct tree node associated with this construct.
The stack in which this resource is defined.
The DLQ associated with this subscription if present.
|to||Returns a string representation of this construct.|
public toString(): string
Returns a string representation of this construct.