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 details)

Uploaded Source

Built Distribution

File details

Details for the file smtp-credentials-cdk-construct-2.0.0.tar.gz.

File metadata

File hashes

Hashes for smtp-credentials-cdk-construct-2.0.0.tar.gz
Algorithm Hash digest
SHA256 519fde4cc430172fd732a49ddb80835861e7dda4ef8993c710af18871fa1c7ba
MD5 4fa40eb71992f20fce16396c8e114002
BLAKE2b-256 d7cc96206b83a5757d718a8fbc12f2649da9bd3d20cd88b900aef8e4b642b769

See more details on using hashes here.

File details

Details for the file smtp_credentials_cdk_construct-2.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for smtp_credentials_cdk_construct-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e9d18ed5ac27b292b0b64d12b994d0685ac5bfab8c2e56b77639f57d4752ccfc
MD5 88c78091809e42a37da620473e23bc5e
BLAKE2b-256 a16fcd8a828aee05928dfe861603040c2940083e959a8d3bf382204e776a3d13

See more details on using hashes here.

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