software.amazon.awscdk.services.sns

Class Subscription.Builder

java.lang.Object

software.amazon.awscdk.services.sns.Subscription.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Subscription>

Enclosing class:

Subscription

@Stability(value=Stable)
public static final class Subscription.Builder
extends Object
implements software.amazon.jsii.Builder<Subscription>

A fluent builder for Subscription.

Method Summary

Modifier and Type	Method and Description
Subscription	build()
static Subscription.Builder	create(software.constructs.Construct scope, String id)
Subscription.Builder	deadLetterQueue(IQueue deadLetterQueue) Queue to be used as dead letter queue.
Subscription.Builder	endpoint(String endpoint) The subscription endpoint.
Subscription.Builder	filterPolicy(Map<String,? extends SubscriptionFilter> filterPolicy) The filter policy.
Subscription.Builder	protocol(SubscriptionProtocol protocol) What type of subscription to add.
Subscription.Builder	rawMessageDelivery(Boolean rawMessageDelivery) true if raw message delivery is enabled for the subscription.
Subscription.Builder	region(String region) The region where the topic resides, in the case of cross-region subscriptions.
Subscription.Builder	subscriptionRoleArn(String subscriptionRoleArn) Arn of role allowing access to firehose delivery stream.
Subscription.Builder	topic(ITopic topic) The topic to subscribe to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static Subscription.Builder create(software.constructs.Construct scope,
                                                                   String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Subscription.Builder.

endpoint

@Stability(value=Stable)
public Subscription.Builder endpoint(String endpoint)

The subscription endpoint.

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

Parameters:

endpoint - The subscription endpoint. This parameter is required.

Returns:

this

protocol

@Stability(value=Stable)
public Subscription.Builder protocol(SubscriptionProtocol protocol)

What type of subscription to add.

Parameters:

protocol - What type of subscription to add. This parameter is required.

Returns:

this

deadLetterQueue

@Stability(value=Stable)
public Subscription.Builder deadLetterQueue(IQueue deadLetterQueue)

Queue to be used as dead letter queue.

If not passed no dead letter queue is enabled.

Default: - No dead letter queue enabled.

Parameters:

deadLetterQueue - Queue to be used as dead letter queue. This parameter is required.

Returns:

this

filterPolicy

@Stability(value=Stable)
public Subscription.Builder filterPolicy(Map<String,? extends SubscriptionFilter> filterPolicy)

The filter policy.

Default: - all messages are delivered

Parameters:

filterPolicy - The filter policy. This parameter is required.

Returns:

this

rawMessageDelivery

@Stability(value=Stable)
public Subscription.Builder rawMessageDelivery(Boolean rawMessageDelivery)

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

Parameters:

rawMessageDelivery - true if raw message delivery is enabled for the subscription. This parameter is required.

Returns:

this

region

@Stability(value=Stable)
public Subscription.Builder region(String region)

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

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

Parameters:

region - The region where the topic resides, in the case of cross-region subscriptions. This parameter is required.

Returns:

this

subscriptionRoleArn

@Stability(value=Stable)
public Subscription.Builder subscriptionRoleArn(String subscriptionRoleArn)

Arn of role allowing access to firehose delivery stream.

Required for a firehose subscription protocol.

Default: - No subscription role is provided

Parameters:

subscriptionRoleArn - Arn of role allowing access to firehose delivery stream. This parameter is required.

Returns:

this

topic

@Stability(value=Stable)
public Subscription.Builder topic(ITopic topic)

The topic to subscribe to.

Parameters:

topic - The topic to subscribe to. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public Subscription build()

Specified by:

build in interface software.amazon.jsii.Builder<Subscription>