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

Class SmsSubscription.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<SmsSubscription>

Enclosing class:

SmsSubscription

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

A fluent builder for SmsSubscription.

Method Summary

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

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 SmsSubscription.Builder create(String phoneNumber)

Parameters:

phoneNumber - This parameter is required.

Returns:

a new instance of SmsSubscription.Builder.

deadLetterQueue

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

build

@Stability(Stable)
public SmsSubscription build()

Specified by:

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

Returns:

a newly built instance of SmsSubscription.