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

Class VerifySesDomain.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static VerifySesDomain.Builder create​(software.constructs.Construct parent,
                                             String name)
        Parameters:
        parent - This parameter is required.
        name - This parameter is required.
        Returns:
        a new instance of VerifySesDomain.Builder.

      • domainName

        @Stability(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(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(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(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

      • hostedZoneId

        @Stability(Stable)
public VerifySesDomain.Builder hostedZoneId​(String hostedZoneId)
        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.

        Parameters:
        hostedZoneId - Optional: A hosted zone id to be used for retrieving the Route53 hosted zone for adding new records. This parameter is required.
        Returns:
        this

      • hostedZoneName

        @Stability(Stable)
public VerifySesDomain.Builder hostedZoneName​(String hostedZoneName)
        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

        Parameters:
        hostedZoneName - 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. This parameter is required.
        Returns:
        this

      • notificationTopic

        @Stability(Stable)
public VerifySesDomain.Builder notificationTopic​(software.amazon.awscdk.services.sns.ITopic 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(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

      • removalPolicy

        @Stability(Stable)
public VerifySesDomain.Builder removalPolicy​(software.amazon.awscdk.RemovalPolicy removalPolicy)
        Whether to DESTROY or RETAIN the domain on removal.

        Default: DESTROY

        Parameters:
        removalPolicy - Whether to DESTROY or RETAIN the domain on removal. This parameter is required.
        Returns:
        this