software.amazon.awscdk.services.sns

Interface SubscriptionOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

SubscriptionProps, TopicSubscriptionConfig

All Known Implementing Classes:

SubscriptionOptions.Jsii$Proxy, SubscriptionProps.Jsii$Proxy, TopicSubscriptionConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.243Z")
 @Stability(value=Stable)
public interface SubscriptionOptions
extends software.amazon.jsii.JsiiSerializable

Options for creating a new subscription.

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.*;
 import software.amazon.awscdk.services.sqs.*;
 Queue queue;
 SubscriptionFilter subscriptionFilter;
 SubscriptionOptions subscriptionOptions = SubscriptionOptions.builder()
         .endpoint("endpoint")
         .protocol(SubscriptionProtocol.HTTP)
         // the properties below are optional
         .deadLetterQueue(queue)
         .filterPolicy(Map.of(
                 "filterPolicyKey", subscriptionFilter))
         .rawMessageDelivery(false)
         .region("region")
         .subscriptionRoleArn("subscriptionRoleArn")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static SubscriptionOptions.Builder	builder()
default IQueue	getDeadLetterQueue() Queue to be used as dead letter queue.
String	getEndpoint() The subscription endpoint.
default Map<String,SubscriptionFilter>	getFilterPolicy() The filter policy.
SubscriptionProtocol	getProtocol() What type of subscription to add.
default Boolean	getRawMessageDelivery() true if raw message delivery is enabled for the subscription.
default String	getRegion() The region where the topic resides, in the case of cross-region subscriptions.
default String	getSubscriptionRoleArn() Arn of role allowing access to firehose delivery stream.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEndpoint

@Stability(value=Stable)
 @NotNull
String getEndpoint()

The subscription endpoint.

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

getProtocol

@Stability(value=Stable)
 @NotNull
SubscriptionProtocol getProtocol()

What type of subscription to add.

getDeadLetterQueue

@Stability(value=Stable)
 @Nullable
default IQueue getDeadLetterQueue()

Queue to be used as dead letter queue.

If not passed no dead letter queue is enabled.

Default: - No dead letter queue enabled.

getFilterPolicy

@Stability(value=Stable)
 @Nullable
default Map<String,SubscriptionFilter> getFilterPolicy()

The filter policy.

Default: - all messages are delivered

getRawMessageDelivery

@Stability(value=Stable)
 @Nullable
default Boolean getRawMessageDelivery()

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

getRegion

@Stability(value=Stable)
 @Nullable
default String getRegion()

The region where the topic resides, in the case of cross-region subscriptions.

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

getSubscriptionRoleArn

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

Arn of role allowing access to firehose delivery stream.

Required for a firehose subscription protocol.

Default: - No subscription role is provided

builder

@Stability(value=Stable)
static SubscriptionOptions.Builder builder()

Returns:

a SubscriptionOptions.Builder of SubscriptionOptions