Skip to content

Latest commit

 

History

History
127 lines (71 loc) · 6.69 KB

API.md

File metadata and controls

127 lines (71 loc) · 6.69 KB

API Reference

Classes

Name Description
VerifySesDomain A construct to verify a SES domain identity.
VerifySesEmailAddress A construct to verify an SES email address identity.

Structs

Name Description
IVerifySesDomainProps No description
IVerifySesEmailAddressProps No description

class VerifySesDomain

A construct to verify a SES domain identity.

It initiates a domain verification and can automatically create appropriate records in Route53 to verify the domain. Also, it's possible to attach a notification topic for bounces, complaints or delivery notifications.

Implements: IConstruct, IDependable Extends: Construct

Initializer

new VerifySesDomain(parent: Construct, name: string, props: IVerifySesDomainProps)
  • parent (Construct) No description
  • name (string) No description
  • props (IVerifySesDomainProps) No description
    • domainName (string) A domain name to be used for the SES domain identity, e.g. 'sub-domain.example.org'.
    • addDkimRecords (boolean) Whether to automatically add DKIM records to the hosted zone of your domain. Default: true
    • addMxRecord (boolean) Whether to automatically add a MX record to the hosted zone of your domain. Default: true
    • addTxtRecord (boolean) Whether to automatically add a TXT record to the hosed zone of your domain. Default: true
    • hostedZoneId (string) Optional: A hosted zone id to be used for retrieving the Route53 hosted zone for adding new records. Optional
    • hostedZoneName (string) 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
    • notificationTopic (aws_sns.ITopic) An SNS topic where bounces, complaints or delivery notifications can be sent to. Default: new topic will be created
    • notificationTypes (Array) Select for which notification types you want to configure a topic. Default: [Bounce, Complaint]
    • removalPolicy (RemovalPolicy) Whether to DESTROY or RETAIN the domain on removal. Default: DESTROY

Properties

Name Type Description
notificationTopic aws_sns.ITopic The SNS topic where bounces, complaints or delivery notifications can be sent to.

class VerifySesEmailAddress

A construct to verify an SES email address identity.

It initiates a verification so that SES sends a verification email to the desired email address. This means the owner of the email address still needs to act by clicking the link in the verification email.

Implements: IConstruct, IDependable Extends: Construct

Initializer

new VerifySesEmailAddress(parent: Construct, name: string, props: IVerifySesEmailAddressProps)
  • parent (Construct) No description
  • name (string) No description
  • props (IVerifySesEmailAddressProps) No description
    • emailAddress (string) The email address to be verified, e.g. 'hello@example.org'.
    • region (string) An optional AWS region to validate the email address. Default: The custom resource will be created in the stack region
    • removalPolicy (RemovalPolicy) Whether to DESTROY or RETAIN the email address on removal. Default: DESTROY

struct IVerifySesDomainProps

Name Type Description
domainName string A domain name to be used for the SES domain identity, e.g. 'sub-domain.example.org'.
addDkimRecords? boolean Whether to automatically add DKIM records to the hosted zone of your domain.
Default: true
addMxRecord? boolean Whether to automatically add a MX record to the hosted zone of your domain.
Default: true
addTxtRecord? boolean Whether to automatically add a TXT record to the hosed zone of your domain.
Default: true
hostedZoneId? string Optional: A hosted zone id to be used for retrieving the Route53 hosted zone for adding new records.
Optional
hostedZoneName? string 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
notificationTopic? aws_sns.ITopic An SNS topic where bounces, complaints or delivery notifications can be sent to.
Default: new topic will be created
notificationTypes? Array Select for which notification types you want to configure a topic.
Default: [Bounce, Complaint]
removalPolicy? RemovalPolicy Whether to DESTROY or RETAIN the domain on removal.
Default: DESTROY

struct IVerifySesEmailAddressProps

Name Type Description
emailAddress string The email address to be verified, e.g. 'hello@example.org'.
region? string An optional AWS region to validate the email address.
Default: The custom resource will be created in the stack region
removalPolicy? RemovalPolicy Whether to DESTROY or RETAIN the email address on removal.
Default: DESTROY