Package software.amazon.awscdk.services.sns

Class SubscriptionOptions.Builder

java.lang.Object

software.amazon.awscdk.services.sns.SubscriptionOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SubscriptionOptions>

Enclosing interface:

SubscriptionOptions

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

A builder for SubscriptionOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SubscriptionOptions	build()	Builds the configured instance.
SubscriptionOptions.Builder	deadLetterQueue(IQueue deadLetterQueue)	Sets the value of SubscriptionOptions.getDeadLetterQueue()
SubscriptionOptions.Builder	endpoint(String endpoint)	Sets the value of SubscriptionOptions.getEndpoint()
SubscriptionOptions.Builder	filterPolicy(Map<String,? extends SubscriptionFilter> filterPolicy)	Sets the value of SubscriptionOptions.getFilterPolicy()
SubscriptionOptions.Builder	filterPolicyWithMessageBody(Map<String,? extends FilterOrPolicy> filterPolicyWithMessageBody)	Sets the value of SubscriptionOptions.getFilterPolicyWithMessageBody()
SubscriptionOptions.Builder	protocol(SubscriptionProtocol protocol)	Sets the value of SubscriptionOptions.getProtocol()
SubscriptionOptions.Builder	rawMessageDelivery(Boolean rawMessageDelivery)	Sets the value of SubscriptionOptions.getRawMessageDelivery()
SubscriptionOptions.Builder	region(String region)	Sets the value of SubscriptionOptions.getRegion()
SubscriptionOptions.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

endpoint

@Stability(Stable)
public SubscriptionOptions.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 SubscriptionOptions.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 SubscriptionOptions.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 SubscriptionOptions.Builder filterPolicy(Map<String,? extends SubscriptionFilter> filterPolicy)

Sets the value of SubscriptionOptions.getFilterPolicy()

Parameters:

filterPolicy - The filter policy.

Returns:

this

filterPolicyWithMessageBody

@Stability(Stable)
public SubscriptionOptions.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 SubscriptionOptions.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 SubscriptionOptions.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 SubscriptionOptions.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 SubscriptionOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SubscriptionOptions

Throws:

NullPointerException - if any required attribute was not provided