Package de.sebastianhesse.cdk.ses.verify.constructs

Interface IVerifySesDomainProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IVerifySesDomainProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-11T08:59:10.875Z")
@Stability(Stable)
public interface IVerifySesDomainProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IVerifySesDomainProps.Builder	A builder for IVerifySesDomainProps
static class	IVerifySesDomainProps.Jsii$Proxy	An implementation for IVerifySesDomainProps

Method Summary

Modifier and Type	Method	Description
static IVerifySesDomainProps.Builder	builder()
default Boolean	getAddDkimRecords()	Whether to automatically add DKIM records to the hosted zone of your domain.
default Boolean	getAddMxRecord()	Whether to automatically add a MX record to the hosted zone of your domain.
default Boolean	getAddTxtRecord()	Whether to automatically add a TXT record to the hosed zone of your domain.
String	getDomainName()	A domain name to be used for the SES domain identity, e.g.
default String	getHostedZoneId()	Optional: A hosted zone id to be used for retrieving the Route53 hosted zone for adding new records.
default String	getHostedZoneName()	A hosted zone name to be used for retrieving the Route53 hosted zone for adding new record, e.g.
default software.amazon.awscdk.services.sns.ITopic	getNotificationTopic()	An SNS topic where bounces, complaints or delivery notifications can be sent to.
default List<String>	getNotificationTypes()	Select for which notification types you want to configure a topic.
default software.amazon.awscdk.RemovalPolicy	getRemovalPolicy()	Whether to DESTROY or RETAIN the domain on removal.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

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

getAddDkimRecords

@Stability(Stable)
@Nullable
default Boolean getAddDkimRecords()

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

getAddMxRecord

@Stability(Stable)
@Nullable
default Boolean getAddMxRecord()

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

getAddTxtRecord

@Stability(Stable)
@Nullable
default Boolean getAddTxtRecord()

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

getHostedZoneId

@Stability(Stable)
@Nullable
default String getHostedZoneId()

Optional: A hosted zone id to be used for retrieving the Route53 hosted zone for adding new records.

Providing an id will skip the hosted zone lookup.

getHostedZoneName

@Stability(Stable)
@Nullable
default String getHostedZoneName()

A hosted zone name to be used for retrieving the Route53 hosted zone for adding new record, e.g. 'example.org'. If you also provide hostedZoneId, it is assumed that these values are correct and no lookup happens.

Default: same as domainName

getNotificationTopic

@Stability(Stable)
@Nullable
default software.amazon.awscdk.services.sns.ITopic getNotificationTopic()

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

getNotificationTypes

@Stability(Stable)
@Nullable
default List<String> getNotificationTypes()

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

Default: [Bounce, Complaint]

getRemovalPolicy

@Stability(Stable)
@Nullable
default software.amazon.awscdk.RemovalPolicy getRemovalPolicy()

Whether to DESTROY or RETAIN the domain on removal.

Default: DESTROY

builder

@Stability(Stable)
static IVerifySesDomainProps.Builder builder()

Returns:

a IVerifySesDomainProps.Builder of IVerifySesDomainProps