Package software.amazon.awscdk.services.sns.subscriptions

Class SqsSubscription.Builder

java.lang.Object

software.amazon.awscdk.services.sns.subscriptions.SqsSubscription.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SqsSubscription>

Enclosing class:

SqsSubscription

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

A fluent builder for SqsSubscription.

Method Summary

Modifier and Type	Method	Description
SqsSubscription	build()
static SqsSubscription.Builder	create(IQueue queue)
SqsSubscription.Builder	deadLetterQueue(IQueue deadLetterQueue)	Queue to be used as dead letter queue.
SqsSubscription.Builder	filterPolicy(Map<String,? extends SubscriptionFilter> filterPolicy)	The filter policy.
SqsSubscription.Builder	filterPolicyWithMessageBody(Map<String,? extends FilterOrPolicy> filterPolicyWithMessageBody)	The filter policy that is applied on the message body.
SqsSubscription.Builder	rawMessageDelivery(Boolean rawMessageDelivery)	The message to the queue is the same as it was sent to the topic.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static SqsSubscription.Builder create(IQueue queue)

Parameters:

queue - This parameter is required.

Returns:

a new instance of SqsSubscription.Builder.

deadLetterQueue

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

filterPolicyWithMessageBody

@Stability(Stable)
public SqsSubscription.Builder filterPolicyWithMessageBody(Map<String,? extends FilterOrPolicy> 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.

Default: - all messages are delivered

Parameters:

filterPolicyWithMessageBody - The filter policy that is applied on the message body. This parameter is required.

Returns:

this

rawMessageDelivery

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

The message to the queue is the same as it was sent to the topic.

If false, the message will be wrapped in an SNS envelope.

Default: false

Parameters:

rawMessageDelivery - The message to the queue is the same as it was sent to the topic. This parameter is required.

Returns:

this

build

@Stability(Stable)
public SqsSubscription build()

Specified by:

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

Returns:

a newly built instance of SqsSubscription.