Package software.amazon.awscdk.services.sns

Class TopicSubscriptionConfig.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.sns.TopicSubscriptionConfig.Jsii$Proxy
All Implemented Interfaces:
SubscriptionOptions, TopicSubscriptionConfig, software.amazon.jsii.JsiiSerializable
Enclosing interface:
TopicSubscriptionConfig
@Stability(Stable) @Internal public static final class TopicSubscriptionConfig.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements TopicSubscriptionConfig
An implementation for TopicSubscriptionConfig

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(TopicSubscriptionConfig.Builder builder)
      Constructor that initializes the object based on literal property values passed by the TopicSubscriptionConfig.Builder.

  • Method Details

    • getSubscriberId

      public final String getSubscriberId()
      Description copied from interface: TopicSubscriptionConfig
      The id of the SNS subscription resource created under scope.

      In most cases, it is recommended to use the uniqueId of the topic you are subscribing to.

      Specified by:
      getSubscriberId in interface TopicSubscriptionConfig

    • getSubscriberScope

      public final software.constructs.Construct getSubscriberScope()
      Description copied from interface: TopicSubscriptionConfig
      The scope in which to create the SNS subscription resource.

      Normally you'd want the subscription to be created on the consuming stack because the topic is usually referenced by the consumer's resource policy (e.g. SQS queue policy). Otherwise, it will cause a cyclic reference.

      If this is undefined, the subscription will be created on the topic's stack.

      Default: - use the topic as the scope of the subscription, in which case `subscriberId` must be defined.

      Specified by:
      getSubscriberScope in interface TopicSubscriptionConfig

    • getSubscriptionDependency

      public final software.constructs.IDependable getSubscriptionDependency()
      Description copied from interface: TopicSubscriptionConfig
      The resources that need to be created before the subscription can be safely created.

      For example for SQS subscription, the subscription needs to have a dependency on the SQS queue policy in order for the subscription to successfully deliver messages.

      Default: - empty list

      Specified by:
      getSubscriptionDependency in interface TopicSubscriptionConfig

    • getEndpoint

      public final String getEndpoint()
      Description copied from interface: SubscriptionOptions
      The subscription endpoint.

      The meaning of this value depends on the value for 'protocol'.

      Specified by:
      getEndpoint in interface SubscriptionOptions

    • getProtocol

      public final SubscriptionProtocol getProtocol()
      Description copied from interface: SubscriptionOptions
      What type of subscription to add.
      Specified by:
      getProtocol in interface SubscriptionOptions

    • getDeadLetterQueue

      public final IQueue getDeadLetterQueue()
      Description copied from interface: SubscriptionOptions
      Queue to be used as dead letter queue.

      If not passed no dead letter queue is enabled.

      Default: - No dead letter queue enabled.

      Specified by:
      getDeadLetterQueue in interface SubscriptionOptions

    • getDeliveryPolicy

      public final DeliveryPolicy getDeliveryPolicy()
      Description copied from interface: SubscriptionOptions
      The delivery policy.

      Default: - if the initial delivery of the message fails, three retries with a delay between failed attempts set at 20 seconds

      Specified by:
      getDeliveryPolicy in interface SubscriptionOptions

    • getFilterPolicy

      public final Map<String,SubscriptionFilter> getFilterPolicy()
      Description copied from interface: SubscriptionOptions
      The filter policy.

      Default: - all messages are delivered

      Specified by:
      getFilterPolicy in interface SubscriptionOptions

    • getFilterPolicyWithMessageBody

      public final Map<String,FilterOrPolicy> getFilterPolicyWithMessageBody()
      Description copied from interface: SubscriptionOptions
      The filter policy that is applied on the message body.

      To apply a filter policy to the message attributes, use filterPolicy. A maximum of one of filterPolicyWithMessageBody and filterPolicy may be used.

      Default: - all messages are delivered

      Specified by:
      getFilterPolicyWithMessageBody in interface SubscriptionOptions

    • getRawMessageDelivery

      public final Boolean getRawMessageDelivery()
      Description copied from interface: SubscriptionOptions
      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.

      Default: false

      Specified by:
      getRawMessageDelivery in interface SubscriptionOptions

    • getRegion

      public final String getRegion()
      Description copied from interface: SubscriptionOptions
      The region where the topic resides, in the case of cross-region subscriptions.

      Default: - the region where the CloudFormation stack is being deployed.

      Specified by:
      getRegion in interface SubscriptionOptions

    • getSubscriptionRoleArn

      public final String getSubscriptionRoleArn()
      Description copied from interface: SubscriptionOptions
      Arn of role allowing access to firehose delivery stream.

      Required for a firehose subscription protocol.

      Default: - No subscription role is provided

      Specified by:
      getSubscriptionRoleArn in interface SubscriptionOptions

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object