Class CfnSubscriptionProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.sns.CfnSubscriptionProps.Jsii$Proxy
All Implemented Interfaces:
CfnSubscriptionProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnSubscriptionProps

@Stability(Stable) @Internal public static final class CfnSubscriptionProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnSubscriptionProps
An implementation for CfnSubscriptionProps
  • 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(CfnSubscriptionProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnSubscriptionProps.Builder.
  • Method Details

    • getProtocol

      public final String getProtocol()
      Description copied from interface: CfnSubscriptionProps
      The subscription's protocol.

      For more information, see the Protocol parameter of the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) action in the Amazon SNS API Reference .

      Specified by:
      getProtocol in interface CfnSubscriptionProps
    • getTopicArn

      public final String getTopicArn()
      Description copied from interface: CfnSubscriptionProps
      The ARN of the topic to subscribe to.
      Specified by:
      getTopicArn in interface CfnSubscriptionProps
    • getDeliveryPolicy

      public final Object getDeliveryPolicy()
      Description copied from interface: CfnSubscriptionProps
      The delivery policy JSON assigned to the subscription.

      Enables the subscriber to define the message delivery retry strategy in the case of an HTTP/S endpoint subscribed to the topic. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) in the Amazon SNS API Reference and Message delivery retries in the Amazon SNS Developer Guide .

      Specified by:
      getDeliveryPolicy in interface CfnSubscriptionProps
    • getEndpoint

      public final String getEndpoint()
      Description copied from interface: CfnSubscriptionProps
      The subscription's endpoint.

      The endpoint value depends on the protocol that you specify. For more information, see the Endpoint parameter of the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) action in the Amazon SNS API Reference .

      Specified by:
      getEndpoint in interface CfnSubscriptionProps
    • getFilterPolicy

      public final Object getFilterPolicy()
      Description copied from interface: CfnSubscriptionProps
      The filter policy JSON assigned to the subscription.

      Enables the subscriber to filter out unwanted messages. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) in the Amazon SNS API Reference and Message filtering in the Amazon SNS Developer Guide .

      Specified by:
      getFilterPolicy in interface CfnSubscriptionProps
    • getFilterPolicyScope

      public final String getFilterPolicyScope()
      Description copied from interface: CfnSubscriptionProps
      This attribute lets you choose the filtering scope by using one of the following string value types:.

      • MessageAttributes (default) - The filter is applied on the message attributes.
      • MessageBody - The filter is applied on the message body.
      Specified by:
      getFilterPolicyScope in interface CfnSubscriptionProps
    • getRawMessageDelivery

      public final Object getRawMessageDelivery()
      Description copied from interface: CfnSubscriptionProps
      When set to true , enables raw message delivery.

      Raw messages don't contain any JSON formatting and can be sent to Amazon SQS and HTTP/S endpoints. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) in the Amazon SNS API Reference .

      Specified by:
      getRawMessageDelivery in interface CfnSubscriptionProps
    • getRedrivePolicy

      public final Object getRedrivePolicy()
      Description copied from interface: CfnSubscriptionProps
      When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue.

      Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

      For more information about the redrive policy and dead-letter queues, see Amazon SQS dead-letter queues in the Amazon SQS Developer Guide .

      Specified by:
      getRedrivePolicy in interface CfnSubscriptionProps
    • getRegion

      public final String getRegion()
      Description copied from interface: CfnSubscriptionProps
      For cross-region subscriptions, the region in which the topic resides.

      If no region is specified, AWS CloudFormation uses the region of the caller as the default.

      If you perform an update operation that only updates the Region property of a AWS::SNS::Subscription resource, that operation will fail unless you are either:

      • Updating the Region from NULL to the caller region.
      • Updating the Region from the caller region to NULL .
      Specified by:
      getRegion in interface CfnSubscriptionProps
    • getSubscriptionRoleArn

      public final String getSubscriptionRoleArn()
      Description copied from interface: CfnSubscriptionProps
      This property applies only to Amazon Kinesis Data Firehose delivery stream subscriptions.

      Specify the ARN of the IAM role that has the following:

      • Permission to write to the Amazon Kinesis Data Firehose delivery stream
      • Amazon SNS listed as a trusted entity

      Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Amazon Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

      Specified by:
      getSubscriptionRoleArn in interface CfnSubscriptionProps
    • $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