Skip to main content

A CDK construct that creates SMTP credentials permitting emails to be sent via SES.

Project description

Charles Dot Fish

SMTP Credentials CDK Construct

Code Coverage GitHub Issues GitHub Pull Requests

This construct creates an IAM user, with a policy permitting emails to be sent via SES from a specified email address, creates an access key associated with this user, and converts the access key to SMTP credentials.

The generated SMTP credentials are stored as a parameter in Parameter Store, and the name of this parameter is output as a CloudFormation output. The parameter may be safely deleted, once the credentials have been accessed.

Installation

JavaScript / TypeScript (npm / Yarn)

# npm
npm i -D @charlesdotfish/smtp-credentials-cdk-construct

# Yarn
yarn add -D @charlesdotfish/smtp-credentials-cdk-construct

See more details at npmjs.com: https://www.npmjs.com/package/@charlesdotfish/smtp-credentials-cdk-construct

C# / .NET (NuGet)

dotnet add package CharlesDotFish.CdkConstructs.SmtpCredentials

See more details at nuget.org: https://www.nuget.org/packages/CharlesDotFish.CdkConstructs.SmtpCredentials/

Python (pip)

pip install smtp-credentials-cdk-construct

See more details at pypi.org: https://pypi.org/project/smtp-credentials-cdk-construct/

Java (Maven)

<dependency>
  <groupId>fish.charles.cdk-constructs</groupId>
  <artifactId>smtp-credentials-cdk-construct</artifactId>
  <version>1.0</version>
</dependency>

See more details at maven.org: https://search.maven.org/artifact/fish.charles.cdk-constructs/smtp-credentials-cdk-construct

Example Usage

See API.md for details on the exposed API.

new SmtpCredentials(this, 'SmtpCredentials', {
    emailAddress: 'me@charles.fish',
});

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

smtp-credentials-cdk-construct-2.0.0.tar.gz (44.2 kB view hashes)

Uploaded Source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page