Package software.amazon.awscdk.services.sns

Interface CfnSubscriptionProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnSubscriptionProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:38.157Z") @Stability(Stable) public interface CfnSubscriptionProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnSubscription.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sns.*;
 Object deliveryPolicy;
 Object filterPolicy;
 Object redrivePolicy;
 CfnSubscriptionProps cfnSubscriptionProps = CfnSubscriptionProps.builder()
         .protocol("protocol")
         .topicArn("topicArn")
         // the properties below are optional
         .deliveryPolicy(deliveryPolicy)
         .endpoint("endpoint")
         .filterPolicy(filterPolicy)
         .filterPolicyScope("filterPolicyScope")
         .rawMessageDelivery(false)
         .redrivePolicy(redrivePolicy)
         .region("region")
         .subscriptionRoleArn("subscriptionRoleArn")
         .build();

  • Method Details

    • getProtocol

      @Stability(Stable) @NotNull String getProtocol()
      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 .

    • getTopicArn

      @Stability(Stable) @NotNull String getTopicArn()
      The ARN of the topic to subscribe to.

    • getDeliveryPolicy

      @Stability(Stable) @Nullable default Object getDeliveryPolicy()
      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 .

    • getEndpoint

      @Stability(Stable) @Nullable default String getEndpoint()
      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 .

    • getFilterPolicy

      @Stability(Stable) @Nullable default Object getFilterPolicy()
      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 .

    • getFilterPolicyScope

      @Stability(Stable) @Nullable default String getFilterPolicyScope()
      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.

    • getRawMessageDelivery

      @Stability(Stable) @Nullable default Object getRawMessageDelivery()
      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 .

    • getRedrivePolicy

      @Stability(Stable) @Nullable default Object getRedrivePolicy()
      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 .

    • getRegion

      @Stability(Stable) @Nullable default String getRegion()
      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 .

    • getSubscriptionRoleArn

      @Stability(Stable) @Nullable default String getSubscriptionRoleArn()
      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.

    • builder

      @Stability(Stable) static CfnSubscriptionProps.Builder builder()
      Returns:
      a CfnSubscriptionProps.Builder of CfnSubscriptionProps