Package software.amazon.awscdk.services.ses

Class EmailIdentityProps.Builder

java.lang.Object

software.amazon.awscdk.services.ses.EmailIdentityProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EmailIdentityProps>

Enclosing interface:

EmailIdentityProps

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

A builder for EmailIdentityProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EmailIdentityProps	build()	Builds the configured instance.
EmailIdentityProps.Builder	configurationSet(IConfigurationSet configurationSet)	Sets the value of EmailIdentityProps.getConfigurationSet()
EmailIdentityProps.Builder	dkimIdentity(DkimIdentity dkimIdentity)	Sets the value of EmailIdentityProps.getDkimIdentity()
EmailIdentityProps.Builder	dkimSigning(Boolean dkimSigning)	Sets the value of EmailIdentityProps.getDkimSigning()
EmailIdentityProps.Builder	feedbackForwarding(Boolean feedbackForwarding)	Sets the value of EmailIdentityProps.getFeedbackForwarding()
EmailIdentityProps.Builder	identity(Identity identity)	Sets the value of EmailIdentityProps.getIdentity()
EmailIdentityProps.Builder	mailFromBehaviorOnMxFailure(MailFromBehaviorOnMxFailure mailFromBehaviorOnMxFailure)	Sets the value of EmailIdentityProps.getMailFromBehaviorOnMxFailure()
EmailIdentityProps.Builder	mailFromDomain(String mailFromDomain)	Sets the value of EmailIdentityProps.getMailFromDomain()

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

identity

@Stability(Stable)
public EmailIdentityProps.Builder identity(Identity identity)

Sets the value of EmailIdentityProps.getIdentity()

Parameters:

identity - The email address or domain to verify. This parameter is required.

Returns:

this

configurationSet

@Stability(Stable)
public EmailIdentityProps.Builder configurationSet(IConfigurationSet configurationSet)

Sets the value of EmailIdentityProps.getConfigurationSet()

Parameters:

configurationSet - The configuration set to associate with the email identity.

Returns:

this

dkimIdentity

@Stability(Stable)
public EmailIdentityProps.Builder dkimIdentity(DkimIdentity dkimIdentity)

Sets the value of EmailIdentityProps.getDkimIdentity()

Parameters:

dkimIdentity - The type of DKIM identity to use.

Returns:

this

dkimSigning

@Stability(Stable)
public EmailIdentityProps.Builder dkimSigning(Boolean dkimSigning)

Sets the value of EmailIdentityProps.getDkimSigning()

Parameters:

dkimSigning - Whether the messages that are sent from the identity are signed using DKIM.

Returns:

this

feedbackForwarding

@Stability(Stable)
public EmailIdentityProps.Builder feedbackForwarding(Boolean feedbackForwarding)

Sets the value of EmailIdentityProps.getFeedbackForwarding()

Parameters:

feedbackForwarding - Whether to receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the Return-Path header of the original email.

You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).

Returns:

this

mailFromBehaviorOnMxFailure

@Stability(Stable)
public EmailIdentityProps.Builder mailFromBehaviorOnMxFailure(MailFromBehaviorOnMxFailure mailFromBehaviorOnMxFailure)

Sets the value of EmailIdentityProps.getMailFromBehaviorOnMxFailure()

Parameters:

mailFromBehaviorOnMxFailure - The action to take if the required MX record for the MAIL FROM domain isn't found when you send an email.

Returns:

this

mailFromDomain

@Stability(Stable)
public EmailIdentityProps.Builder mailFromDomain(String mailFromDomain)

Sets the value of EmailIdentityProps.getMailFromDomain()

Parameters:

mailFromDomain - The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:

• It has to be a subdomain of the verified identity
• It can't be used to receive email
• It can't be used in a "From" address if the MAIL FROM domain is a destination for feedback forwarding emails

Returns:

this

build

@Stability(Stable)
public EmailIdentityProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of EmailIdentityProps

Throws:

NullPointerException - if any required attribute was not provided