Package software.amazon.awscdk.services.sns

Interface SubscriptionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, SubscriptionOptions

All Known Implementing Classes:

SubscriptionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-02T11:25:40.835Z")
@Stability(Stable)
public interface SubscriptionProps
extends software.amazon.jsii.JsiiSerializable, SubscriptionOptions

Properties for creating a new subscription.

Example:

 import software.amazon.awscdk.services.kinesisfirehose.*;
 DeliveryStream stream;
 Topic topic = new Topic(this, "Topic");
 Subscription.Builder.create(this, "Subscription")
         .topic(topic)
         .endpoint(stream.getDeliveryStreamArn())
         .protocol(SubscriptionProtocol.FIREHOSE)
         .subscriptionRoleArn("SAMPLE_ARN")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SubscriptionProps.Builder	A builder for SubscriptionProps
static final class	SubscriptionProps.Jsii$Proxy	An implementation for SubscriptionProps

Method Summary

Modifier and Type	Method	Description
static SubscriptionProps.Builder	builder()
ITopic	getTopic()	The topic to subscribe to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.sns.SubscriptionOptions

getDeadLetterQueue, getDeliveryPolicy, getEndpoint, getFilterPolicy, getFilterPolicyWithMessageBody, getProtocol, getRawMessageDelivery, getRegion, getSubscriptionRoleArn

Method Details

getTopic

@Stability(Stable)
@NotNull
ITopic getTopic()

The topic to subscribe to.

builder

@Stability(Stable)
static SubscriptionProps.Builder builder()

Returns:

a SubscriptionProps.Builder of SubscriptionProps