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:
IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-25T14:21:24.044Z") @Stability(Stable) public class Subscription extends Resource
A new subscription.

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

Example: 

 import software.amazon.awscdk.services.kinesisfirehose.alpha.DeliveryStream;
 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
    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

  • 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

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

    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

  • 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.