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.97.0 (build 729de35)",
           date="2024-04-24T21:00:37.694Z")
@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;
 Object replayPolicy;
 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")
         .replayPolicy(replayPolicy)
         .subscriptionRoleArn("subscriptionRoleArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSubscriptionProps.Builder	A builder for CfnSubscriptionProps
static final class	CfnSubscriptionProps.Jsii$Proxy	An implementation for CfnSubscriptionProps

Method Summary

Modifier and Type	Method	Description
static CfnSubscriptionProps.Builder	builder()
default Object	getDeliveryPolicy()	The delivery policy JSON assigned to the subscription.
default String	getEndpoint()	The subscription's endpoint.
default Object	getFilterPolicy()	The filter policy JSON assigned to the subscription.
default String	getFilterPolicyScope()	This attribute lets you choose the filtering scope by using one of the following string value types:.
String	getProtocol()	The subscription's protocol.
default Object	getRawMessageDelivery()	When set to true , enables raw message delivery.
default Object	getRedrivePolicy()	When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue.
default String	getRegion()	For cross-region subscriptions, the region in which the topic resides.
default Object	getReplayPolicy()
default String	getSubscriptionRoleArn()	This property applies only to Amazon Data Firehose delivery stream subscriptions.
String	getTopicArn()	The ARN of the topic to subscribe to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-protocol

getTopicArn

@Stability(Stable)
@NotNull
String getTopicArn()

The ARN of the topic to subscribe to.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-topicarn

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-deliverypolicy

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-endpoint

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicyscope

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-rawmessagedelivery

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-redrivepolicy

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-region

getReplayPolicy

@Stability(Stable)
@Nullable
default Object getReplayPolicy()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-replaypolicy

getSubscriptionRoleArn

@Stability(Stable)
@Nullable
default String getSubscriptionRoleArn()

This property applies only to Amazon Data Firehose delivery stream subscriptions.

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

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-subscriptionrolearn

builder

@Stability(Stable)
static CfnSubscriptionProps.Builder builder()

Returns:

a CfnSubscriptionProps.Builder of CfnSubscriptionProps