de.sebastianhesse.cdk.ses.email.forwarding

Class EmailForwardingProps.Builder

java.lang.Object

de.sebastianhesse.cdk.ses.email.forwarding.EmailForwardingProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EmailForwardingProps>

Enclosing interface:

EmailForwardingProps

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

A builder for EmailForwardingProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
EmailForwardingProps.Builder	bucket(software.amazon.awscdk.services.s3.Bucket bucket) Sets the value of EmailForwardingProps.getBucket()
EmailForwardingProps.Builder	bucketPrefix(String bucketPrefix) Sets the value of EmailForwardingProps.getBucketPrefix()
EmailForwardingProps	build() Builds the configured instance.
EmailForwardingProps.Builder	domainName(String domainName) Sets the value of EmailForwardingProps.getDomainName()
EmailForwardingProps.Builder	emailMappings(List<? extends EmailMapping> emailMappings) Sets the value of EmailForwardingProps.getEmailMappings()
EmailForwardingProps.Builder	fromPrefix(String fromPrefix) Sets the value of EmailForwardingProps.getFromPrefix()
EmailForwardingProps.Builder	notificationTopic(software.amazon.awscdk.services.sns.Topic notificationTopic) Sets the value of EmailForwardingProps.getNotificationTopic()
EmailForwardingProps.Builder	notificationTypes(List<String> notificationTypes) Sets the value of EmailForwardingProps.getNotificationTypes()
EmailForwardingProps.Builder	verifyDomain(Boolean verifyDomain) Sets the value of EmailForwardingProps.getVerifyDomain()
EmailForwardingProps.Builder	verifyTargetEmailAddresses(Boolean verifyTargetEmailAddresses) Sets the value of EmailForwardingProps.getVerifyTargetEmailAddresses()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

domainName

@Stability(value=Stable)
public EmailForwardingProps.Builder domainName(String domainName)

Sets the value of EmailForwardingProps.getDomainName()

Parameters:

domainName - The domain name for which you want to receive emails using SES, e.g. `example.org`. This parameter is required.

Returns:

this

emailMappings

@Stability(value=Stable)
public EmailForwardingProps.Builder emailMappings(List<? extends EmailMapping> emailMappings)

Sets the value of EmailForwardingProps.getEmailMappings()

Parameters:

emailMappings - A list of email mappings to define the receive email address and target email addresses to which the emails are forwarded to. This parameter is required.

Returns:

this

fromPrefix

@Stability(value=Stable)
public EmailForwardingProps.Builder fromPrefix(String fromPrefix)

Sets the value of EmailForwardingProps.getFromPrefix()

Parameters:

fromPrefix - A prefix that is used as the sender address of the forwarded mail, e.g. `noreply`. This parameter is required.

Returns:

this

bucket

@Stability(value=Stable)
public EmailForwardingProps.Builder bucket(software.amazon.awscdk.services.s3.Bucket bucket)

Sets the value of EmailForwardingProps.getBucket()

Parameters:

bucket - Optional: an S3 bucket to store the received emails. If none is provided, a new one will be created.

Returns:

this

bucketPrefix

@Stability(value=Stable)
public EmailForwardingProps.Builder bucketPrefix(String bucketPrefix)

Sets the value of EmailForwardingProps.getBucketPrefix()

Parameters:

bucketPrefix - Optional: a prefix for the email files that are stored on the S3 bucket.

Returns:

this

notificationTopic

@Stability(value=Stable)
public EmailForwardingProps.Builder notificationTopic(software.amazon.awscdk.services.sns.Topic notificationTopic)

Sets the value of EmailForwardingProps.getNotificationTopic()

Parameters:

notificationTopic - Optional: an SNS topic to receive notifications about sending events like bounces or complaints. The events are defined by notificationTypes using {@link NotificationType}. If no topic is defined, a new one will be created.

Returns:

this

notificationTypes

@Stability(value=Stable)
public EmailForwardingProps.Builder notificationTypes(List<String> notificationTypes)

Sets the value of EmailForwardingProps.getNotificationTypes()

Parameters:

notificationTypes - Optional: a list of NotificationTypes to define which sending events should be subscribed.

Returns:

this

verifyDomain

@Stability(value=Stable)
public EmailForwardingProps.Builder verifyDomain(Boolean verifyDomain)

Sets the value of EmailForwardingProps.getVerifyDomain()

Parameters:

verifyDomain - Optional: true if you want to verify the domain identity in SES, false otherwise.

Returns:

this

verifyTargetEmailAddresses

@Stability(value=Stable)
public EmailForwardingProps.Builder verifyTargetEmailAddresses(Boolean verifyTargetEmailAddresses)

Sets the value of EmailForwardingProps.getVerifyTargetEmailAddresses()

Parameters:

verifyTargetEmailAddresses - Optional: true if you want to initiate the verification of your target email addresses, false otherwise. If true, a verification email is sent out to all target email addresses. Then, the owner of an email address needs to verify it by clicking the link in the verification email. Please note in case you don't verify your sender domain, it's required to verify your target email addresses in order to send mails to them.

Returns:

this

build

@Stability(value=Stable)
public EmailForwardingProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of EmailForwardingProps

Throws:

NullPointerException - if any required attribute was not provided