Package software.amazon.awscdk.services.sns

Class TopicSubscriptionConfig.Builder

java.lang.Object

software.amazon.awscdk.services.sns.TopicSubscriptionConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TopicSubscriptionConfig>

Enclosing interface:

TopicSubscriptionConfig

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

A builder for TopicSubscriptionConfig

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TopicSubscriptionConfig	build()	Builds the configured instance.
TopicSubscriptionConfig.Builder	deadLetterQueue(IQueue deadLetterQueue)	Sets the value of SubscriptionOptions.getDeadLetterQueue()
TopicSubscriptionConfig.Builder	endpoint(String endpoint)	Sets the value of SubscriptionOptions.getEndpoint()
TopicSubscriptionConfig.Builder	filterPolicy(Map<String,? extends SubscriptionFilter> filterPolicy)	Sets the value of SubscriptionOptions.getFilterPolicy()
TopicSubscriptionConfig.Builder	filterPolicyWithMessageBody(Map<String,? extends FilterOrPolicy> filterPolicyWithMessageBody)	Sets the value of SubscriptionOptions.getFilterPolicyWithMessageBody()
TopicSubscriptionConfig.Builder	protocol(SubscriptionProtocol protocol)	Sets the value of SubscriptionOptions.getProtocol()
TopicSubscriptionConfig.Builder	rawMessageDelivery(Boolean rawMessageDelivery)	Sets the value of SubscriptionOptions.getRawMessageDelivery()
TopicSubscriptionConfig.Builder	region(String region)	Sets the value of SubscriptionOptions.getRegion()
TopicSubscriptionConfig.Builder	subscriberId(String subscriberId)	Sets the value of TopicSubscriptionConfig.getSubscriberId()
TopicSubscriptionConfig.Builder	subscriberScope(software.constructs.Construct subscriberScope)	Sets the value of TopicSubscriptionConfig.getSubscriberScope()
TopicSubscriptionConfig.Builder	subscriptionDependency(software.constructs.IDependable subscriptionDependency)	Sets the value of TopicSubscriptionConfig.getSubscriptionDependency()
TopicSubscriptionConfig.Builder	subscriptionRoleArn(String subscriptionRoleArn)	Sets the value of SubscriptionOptions.getSubscriptionRoleArn()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

subscriberId

@Stability(Stable)
public TopicSubscriptionConfig.Builder subscriberId(String subscriberId)

Sets the value of TopicSubscriptionConfig.getSubscriberId()

Parameters:

subscriberId - The id of the SNS subscription resource created under scope. This parameter is required. In most cases, it is recommended to use the uniqueId of the topic you are subscribing to.

Returns:

this

subscriberScope

@Stability(Stable)
public TopicSubscriptionConfig.Builder subscriberScope(software.constructs.Construct subscriberScope)

Sets the value of TopicSubscriptionConfig.getSubscriberScope()

Parameters:

subscriberScope - The scope in which to create the SNS subscription resource. Normally you'd want the subscription to be created on the consuming stack because the topic is usually referenced by the consumer's resource policy (e.g. SQS queue policy). Otherwise, it will cause a cyclic reference.

If this is undefined, the subscription will be created on the topic's stack.

Returns:

this

subscriptionDependency

@Stability(Stable)
public TopicSubscriptionConfig.Builder subscriptionDependency(software.constructs.IDependable subscriptionDependency)

Sets the value of TopicSubscriptionConfig.getSubscriptionDependency()

Parameters:

subscriptionDependency - The resources that need to be created before the subscription can be safely created. For example for SQS subscription, the subscription needs to have a dependency on the SQS queue policy in order for the subscription to successfully deliver messages.

Returns:

this

endpoint

@Stability(Stable)
public TopicSubscriptionConfig.Builder endpoint(String endpoint)

Sets the value of SubscriptionOptions.getEndpoint()

Parameters:

endpoint - The subscription endpoint. This parameter is required. The meaning of this value depends on the value for 'protocol'.

Returns:

this

protocol

@Stability(Stable)
public TopicSubscriptionConfig.Builder protocol(SubscriptionProtocol protocol)

Sets the value of SubscriptionOptions.getProtocol()

Parameters:

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

Returns:

this

deadLetterQueue

@Stability(Stable)
public TopicSubscriptionConfig.Builder deadLetterQueue(IQueue deadLetterQueue)

Sets the value of SubscriptionOptions.getDeadLetterQueue()

Parameters:

deadLetterQueue - Queue to be used as dead letter queue. If not passed no dead letter queue is enabled.

Returns:

this

filterPolicy

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

Sets the value of SubscriptionOptions.getFilterPolicy()

Parameters:

filterPolicy - The filter policy.

Returns:

this

filterPolicyWithMessageBody

@Stability(Stable)
public TopicSubscriptionConfig.Builder filterPolicyWithMessageBody(Map<String,? extends FilterOrPolicy> filterPolicyWithMessageBody)

Sets the value of SubscriptionOptions.getFilterPolicyWithMessageBody()

Parameters:

filterPolicyWithMessageBody - The filter policy that is applied on the message body. To apply a filter policy to the message attributes, use filterPolicy. A maximum of one of filterPolicyWithMessageBody and filterPolicy may be used.

Returns:

this

rawMessageDelivery

@Stability(Stable)
public TopicSubscriptionConfig.Builder rawMessageDelivery(Boolean rawMessageDelivery)

Sets the value of SubscriptionOptions.getRawMessageDelivery()

Parameters:

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.

Returns:

this

region

@Stability(Stable)
public TopicSubscriptionConfig.Builder region(String region)

Sets the value of SubscriptionOptions.getRegion()

Parameters:

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

Returns:

this

subscriptionRoleArn

@Stability(Stable)
public TopicSubscriptionConfig.Builder subscriptionRoleArn(String subscriptionRoleArn)

Sets the value of SubscriptionOptions.getSubscriptionRoleArn()

Parameters:

subscriptionRoleArn - Arn of role allowing access to firehose delivery stream. Required for a firehose subscription protocol.

Returns:

this

build

@Stability(Stable)
public TopicSubscriptionConfig build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of TopicSubscriptionConfig

Throws:

NullPointerException - if any required attribute was not provided