Package software.amazon.awscdk.services.sns

Class Subscription

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.sns.Subscription

All Implemented Interfaces:

IEnvironmentAware, IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.133.0 (build 0f43e37)",
           date="2026-07-02T13:32:48.009Z")
@Stability(Stable)
public class Subscription
extends Resource

A new subscription.

Prefer to use the ITopic.addSubscription() methods to create instances of this class.

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 Classes

Modifier and Type	Class	Description
static final class	Subscription.Builder	A fluent builder for Subscription.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Subscription(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Subscription(software.amazon.jsii.JsiiObjectRef objRef)
	Subscription(software.constructs.Construct scope, String id, SubscriptionProps props)

Method Summary

Modifier and Type	Method	Description
IQueue	getDeadLetterQueue()	The DLQ associated with this subscription if present.

Methods inherited from class software.amazon.awscdk.Resource

applyCrossStackReferenceStrength, applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

Subscription

protected Subscription(software.amazon.jsii.JsiiObjectRef objRef)

Subscription

protected Subscription(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Subscription

@Stability(Stable)
public Subscription(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 SubscriptionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

getDeadLetterQueue

@Stability(Stable)
@Nullable
public IQueue getDeadLetterQueue()

The DLQ associated with this subscription if present.