com.pepperize.cdk.ses_smtp_credentials.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cdk-ses-smtp-credentials Show documentation

Generate SES smtp credentials for a given user and store the credentials in a SecretsManager Secret.

There is a newer version: 0.3.787

Show newest version

/**
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
AWS CDK Ses Smtp Credentials
 * 
 * Generate SES smtp credentials for a user and store the credentials in a SecretsManager Secret.
 * 

 * 
 * 

 * 
Install
 * 
 * 
TypeScript
 * 
 * 
 * npm install @pepperize/cdk-ses-smtp-credentials
 * 
 * 
 * or
 * 

 * 
 * yarn add @pepperize/cdk-ses-smtp-credentials
 * 
 * 
 * 
Python
 * 
 * 
 * pip install pepperize.cdk-ses-smtp-credentials
 * 
 * 
 * 
C# / .Net
 * 
 * 
 * dotnet add package Pepperize.CDK.SesSmtpCredentials
 * 
 * 
 * 
Java
 * 
 * 
 * <dependency>
 *   <groupId>com.pepperize</groupId>
 *   <artifactId>cdk-ses-smtp-credentials</artifactId>
 *   <version>${cdkSesSmtpCredentials.version}</version>
 * </dependency>
 * 
 * 
 * 
Usage
 * 
 * 
 * npm install @pepperize/cdk-ses-smtp-credentials
 * 
 * 
 * See API.md.
 * 

 * 
Create AWS SES Smtp Credentials for a given user
 * 
 * 

 * 
 * Attaches an inline policy to the user allowing to send emails
 * 

 * 
 * 
 * 
 * import { User } from "@aws-cdk/aws-iam";
 * import { SesSmtpCredentials } from "@pepperize/cdk-ses-smtp-credentials";
 * 
 * const user = new User(stack, "SesUser", {
 *   userName: "ses-user",
 * });
 * const smtpCredentials = new SesSmtpCredentials(this, "SmtpCredentials", {
 *   user: user,
 * });
 * 
 * // smtpCredentials.secret contains json value {username: "<the generated access key id>", password: "<the calculated ses smtp password>"}
 * 
 * 
 * See API Reference - SesSmtpCredentials
 * 

 * 
Create AWS SES Smtp Credentials and create a new user
 * 
 * 

 * 
 * Attaches an inline policy to the user allowing to send emails
 * 

 * 
 * 
 * 
 * import { User } from "@aws-cdk/aws-iam";
 * import { SesSmtpCredentials } from "@pepperize/cdk-ses-smtp-credentials";
 * 
 * const smtpCredentials = new SesSmtpCredentials(this, "SmtpCredentials", {
 *   userName: "ses-user",
 * });
 * 
 * // smtpCredentials.secret contains json value {username: "<the generated access key id>", password: "<the calculated ses smtp password>"}
 * 
 * 
 * See API Reference - SesSmtpCredentials
 * 

 * 
Calculate the AWS SES Smtp password on your own
 * 
 * 
 * import * as AWS from "aws-sdk";
 * import { calculateSesSmtpPassword } from "@pepperize/cdk-ses-smtp-credentials";
 * 
 * const iam = new AWS.IAM();
 * const accessKey = await iam
 *   .createAccessKey({
 *     UserName: username,
 *   })
 *   .promise();
 * const accessKeyId = accessKey.AccessKey.AccessKeyId;
 * const secretAccessKey = accessKey.AccessKey.SecretAccessKey;
 * 
 * const password = calculateSesSmtpPassword(secretAccessKey, "us-east-1");
 * 
 * console.log({
 *   username: accessKeyId,
 *   password: password,
 * });
 * 
 * 
 * See Obtaining Amazon SES SMTP credentials by converting existing AWS credentials
 */
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
package com.pepperize.cdk.ses_smtp_credentials;