Interface SubscriptionProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable,SubscriptionOptions
- All Known Implementing Classes:
SubscriptionProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.133.0 (build 0f43e37)",
date="2026-06-16T16:14:33.757Z")
@Stability(Stable)
public interface SubscriptionProps
extends software.amazon.jsii.JsiiSerializable, SubscriptionOptions
Properties for creating a new subscription.
Example:
// producerStack defines an SNS topic
Topic topic;
// consumerStack subscribes to it with a weak reference,
// so the producer can be torn down without blocking on this consumer
Stack consumerStack = Stack.Builder.create(app, "Consumer")
.env(Environment.builder().account("123456789012").region("us-east-1").build())
.build();
Subscription.Builder.create(consumerStack, "Subscription")
.topic(Topic.fromTopicArn(consumerStack, "Topic", Stack.consumeReference(topic.getTopicArn())))
.endpoint("https://example.com/webhook")
.protocol(SubscriptionProtocol.HTTPS)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forSubscriptionPropsstatic final classAn implementation forSubscriptionProps -
Method Summary
Modifier and TypeMethodDescriptionstatic SubscriptionProps.Builderbuilder()getTopic()The topic to subscribe to.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJsonMethods inherited from interface software.amazon.awscdk.services.sns.SubscriptionOptions
getDeadLetterQueue, getDeliveryPolicy, getEndpoint, getFilterPolicy, getFilterPolicyWithMessageBody, getProtocol, getRawMessageDelivery, getRegion, getSubscriptionRoleArn
-
Method Details
-
getTopic
The topic to subscribe to. -
builder
- Returns:
- a
SubscriptionProps.BuilderofSubscriptionProps
-