de.sebastianhesse.cdk.ses.verify.constructs

Class VerifySesDomain.Builder

java.lang.Object

de.sebastianhesse.cdk.ses.verify.constructs.VerifySesDomain.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<VerifySesDomain>

Enclosing class:

VerifySesDomain

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

A fluent builder for VerifySesDomain.

Method Summary

Modifier and Type	Method and Description
VerifySesDomain.Builder	addDkimRecords(Boolean addDkimRecords) Whether to automatically add DKIM records to the hosted zone of your domain.
VerifySesDomain.Builder	addMxRecord(Boolean addMxRecord) Whether to automatically add a MX record to the hosted zone of your domain.
VerifySesDomain.Builder	addTxtRecord(Boolean addTxtRecord) Whether to automatically add a TXT record to the hosed zone of your domain.
VerifySesDomain	build()
static VerifySesDomain.Builder	create(software.amazon.awscdk.core.Construct parent, String name)
VerifySesDomain.Builder	domainName(String domainName) A domain name to be used for the SES domain identity, e.g.
VerifySesDomain.Builder	hostedZoneName(String hostedZoneName) A hostedZone name to be matched with Route 53 record.
VerifySesDomain.Builder	notificationTopic(software.amazon.awscdk.services.sns.Topic notificationTopic) An SNS topic where bounces, complaints or delivery notifications can be sent to.
VerifySesDomain.Builder	notificationTypes(List<String> notificationTypes) Select for which notification types you want to configure a topic.

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 VerifySesDomain.Builder create(software.amazon.awscdk.core.Construct parent,
                                                                      String name)

Parameters:

parent - This parameter is required.

name - This parameter is required.

Returns:

a new instance of VerifySesDomain.Builder.

domainName

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

A domain name to be used for the SES domain identity, e.g. 'sub-domain.example.org'.

Parameters:

domainName - A domain name to be used for the SES domain identity, e.g. 'sub-domain.example.org'. This parameter is required.

Returns:

this

addDkimRecords

@Stability(value=Stable)
public VerifySesDomain.Builder addDkimRecords(Boolean addDkimRecords)

Whether to automatically add DKIM records to the hosted zone of your domain.

This only works if your domain is managed by Route53. Otherwise disable it.

Default: true

Parameters:

addDkimRecords - Whether to automatically add DKIM records to the hosted zone of your domain. This parameter is required.

Returns:

this

addMxRecord

@Stability(value=Stable)
public VerifySesDomain.Builder addMxRecord(Boolean addMxRecord)

Whether to automatically add a MX record to the hosted zone of your domain.

This only works if your domain is managed by Route53. Otherwise disable it.

Default: true

Parameters:

addMxRecord - Whether to automatically add a MX record to the hosted zone of your domain. This parameter is required.

Returns:

this

addTxtRecord

@Stability(value=Stable)
public VerifySesDomain.Builder addTxtRecord(Boolean addTxtRecord)

Whether to automatically add a TXT record to the hosed zone of your domain.

This only works if your domain is managed by Route53. Otherwise disable it.

Default: true

Parameters:

addTxtRecord - Whether to automatically add a TXT record to the hosed zone of your domain. This parameter is required.

Returns:

this

hostedZoneName

@Stability(value=Stable)
public VerifySesDomain.Builder hostedZoneName(String hostedZoneName)

A hostedZone name to be matched with Route 53 record.

e.g. 'example.org'

Default: same as domainName

Parameters:

hostedZoneName - A hostedZone name to be matched with Route 53 record. This parameter is required.

Returns:

this

notificationTopic

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

An SNS topic where bounces, complaints or delivery notifications can be sent to.

If none is provided, a new topic will be created and used for all different notification types.

Default: new topic will be created

Parameters:

notificationTopic - An SNS topic where bounces, complaints or delivery notifications can be sent to. This parameter is required.

Returns:

this

notificationTypes

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

Select for which notification types you want to configure a topic.

Default: [Bounce, Complaint]

Parameters:

notificationTypes - Select for which notification types you want to configure a topic. This parameter is required.

Returns:

this

build

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

Specified by:

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