@iter-idea/ses-verify-identities
v1.0.2
Published
AWS CDK constructs to verify SES identities like domains and email addresses.
Downloads
5
Readme
@iter-idea/ses-verify-identities
Forked from: @seeebiii/ses-verify-identities
This package provides two constructs helping you to verify identities in AWS SES using the AWS CDK.
For more information about verifying identities in AWS SES, read the documentation.
Install
npm
npm i -D @seeebiii/ses-verify-identities
See more details on npmjs.com: https://www.npmjs.com/package/@seeebiii/ses-verify-identities
Maven
<dependency>
<groupId>de.sebastianhesse.cdk-constructs</groupId>
<artifactId>ses-verify-identities</artifactId>
<version>4.0.2</version>
</dependency>
See more details on mvnrepository.com: https://mvnrepository.com/artifact/de.sebastianhesse.cdk-constructs/ses-verify-identities/
Python
pip install ses-verify-identities
See more details on PyPi: https://pypi.org/project/ses-verify-identities/
Dotnet / C#
You can find the details here: https://www.nuget.org/packages/Ses.Verify.Identities/
Usage
Examples below are based on TypeScript. See API.md for a full reference.
Verify a Domain
new VerifySesDomain(this, 'SesDomainVerification', {
domainName: 'example.org'
});
Options
domainName
A domain name to be used for the SES domain identity, e.g. 'example.org'hostedZoneName
A hosted zone name to be matched with a Route 53 record, e.g. 'example.org'. Default: same asdomainName
.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
.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
.addDkimRecord
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
.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 provided notification types.notificationTypes
Select for which notification types you want to configure a topic. Default:[Bounce, Complaint]
.removalPolicy
Set aRemovalPolicy
if you want to retain the resources. Default:DESTROY
Verify an Email Address
new VerifySesEmailAddress(this, 'SesEmailVerification', {
emailAddress: '[email protected]'
});
Options
emailAddress
The email address to be verified, e.g.[email protected]
.region
An optional AWS region to validate the email address. Default: The custom resource will be created in the stack region.removalPolicy
Set aRemovalPolicy
if you want to retain the resources. Default:DESTROY
Contributing
I'm happy to receive any contributions! Just open an issue or pull request :)
These commands should help you while developing:
npx projen
init projen and synthesize changes in .projenrc.js to the projectyarn build
compile typescript to jsyarn watch
watch for changes and compileyarn test
perform the jest unit testsyarn eslint
validate code against best practices
Author
Sebastian Hesse - Freelancer for serverless cloud projects on AWS.
License
MIT License
Copyright (c) 2022 Sebastian Hesse
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.