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

Class EmailSubscription.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<EmailSubscription>

Enclosing class:

EmailSubscription

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

A fluent builder for EmailSubscription.

Method Summary

Modifier and Type	Method	Description
EmailSubscription	build()
static EmailSubscription.Builder	create(String emailAddress)
EmailSubscription.Builder	deadLetterQueue(IQueue deadLetterQueue)	Queue to be used as dead letter queue.
EmailSubscription.Builder	filterPolicy(Map<String,? extends SubscriptionFilter> filterPolicy)	The filter policy.
EmailSubscription.Builder	json(Boolean json)	Indicates if the full notification JSON should be sent to the email address or just the message text.

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 EmailSubscription.Builder create(String emailAddress)

Parameters:

emailAddress - This parameter is required.

Returns:

a new instance of EmailSubscription.Builder.

deadLetterQueue

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

json

@Stability(Stable)
public EmailSubscription.Builder json(Boolean json)

Indicates if the full notification JSON should be sent to the email address or just the message text.

Default: false (Message text)

Parameters:

json - Indicates if the full notification JSON should be sent to the email address or just the message text. This parameter is required.

Returns:

this

build

@Stability(Stable)
public EmailSubscription build()

Specified by:

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

Returns:

a newly built instance of EmailSubscription.