software.amazon.awscdk.services.ses

Class EmailIdentity.Builder

java.lang.Object

software.amazon.awscdk.services.ses.EmailIdentity.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EmailIdentity>

Enclosing class:

EmailIdentity

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

A fluent builder for EmailIdentity.

Method Summary

Modifier and Type	Method and Description
EmailIdentity	build()
EmailIdentity.Builder	configurationSet(IConfigurationSet configurationSet) The configuration set to associate with the email identity.
static EmailIdentity.Builder	create(software.constructs.Construct scope, String id)
EmailIdentity.Builder	dkimIdentity(DkimIdentity dkimIdentity) The type of DKIM identity to use.
EmailIdentity.Builder	dkimSigning(Boolean dkimSigning) Whether the messages that are sent from the identity are signed using DKIM.
EmailIdentity.Builder	feedbackForwarding(Boolean feedbackForwarding) Whether to receive email notifications when bounce or complaint events occur.
EmailIdentity.Builder	identity(Identity identity) The email address or domain to verify.
EmailIdentity.Builder	mailFromBehaviorOnMxFailure(MailFromBehaviorOnMxFailure mailFromBehaviorOnMxFailure) The action to take if the required MX record for the MAIL FROM domain isn't found when you send an email.
EmailIdentity.Builder	mailFromDomain(String mailFromDomain) The custom MAIL FROM domain that you want the verified identity to use.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static EmailIdentity.Builder create(software.constructs.Construct scope,
                                                                    String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of EmailIdentity.Builder.

identity

@Stability(value=Stable)
public EmailIdentity.Builder identity(Identity identity)

The email address or domain to verify.

Parameters:

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

Returns:

this

configurationSet

@Stability(value=Stable)
public EmailIdentity.Builder configurationSet(IConfigurationSet configurationSet)

The configuration set to associate with the email identity.

Default: - do not use a specific configuration set

Parameters:

configurationSet - The configuration set to associate with the email identity. This parameter is required.

Returns:

this

dkimIdentity

@Stability(value=Stable)
public EmailIdentity.Builder dkimIdentity(DkimIdentity dkimIdentity)

The type of DKIM identity to use.

Default: - Easy DKIM with a key length of 2048-bit

Parameters:

dkimIdentity - The type of DKIM identity to use. This parameter is required.

Returns:

this

dkimSigning

@Stability(value=Stable)
public EmailIdentity.Builder dkimSigning(Boolean dkimSigning)

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

Default: true

Parameters:

dkimSigning - Whether the messages that are sent from the identity are signed using DKIM. This parameter is required.

Returns:

this

feedbackForwarding

@Stability(value=Stable)
public EmailIdentity.Builder feedbackForwarding(Boolean 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).

Default: true

Parameters:

feedbackForwarding - Whether to receive email notifications when bounce or complaint events occur. This parameter is required.

Returns:

this

mailFromBehaviorOnMxFailure

@Stability(value=Stable)
public EmailIdentity.Builder mailFromBehaviorOnMxFailure(MailFromBehaviorOnMxFailure mailFromBehaviorOnMxFailure)

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

Default: MailFromBehaviorOnMxFailure.USE_DEFAULT_VALUE

Parameters:

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

Returns:

this

mailFromDomain

@Stability(value=Stable)
public EmailIdentity.Builder mailFromDomain(String 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

Default: - use amazonses.com

Parameters:

mailFromDomain - The custom MAIL FROM domain that you want the verified identity to use. This parameter is required.

Returns:

this

build

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

Specified by:

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