# AWS CDK Construct for Simple Email Service (SES) SMTP Credentials
[](https://github.com/RenovoSolutions/cdk-library-aws-ses-smtp-credentials/actions/workflows/build.yml)
This construct creates SES SMTP Credentials
## Overview
- Creates an IAM user with a policy to send SES emails
- Uses a custom resource to generate then convert AWS credentials to SES SMTP Credentials
- Uploads the resulting SMTP credentials to AWS Secrets Manager
## Usage examples
See [API](API.md) doc for full details
**typescript example:**
```typescript
new SesSmtpCredentials(stack, 'SesSmtpCredentials', {
iamUserName: 'exampleUser',
});
```
## Testing the generated credentials in the CLI
See [this document from AWS](https://docs.aws.amazon.com/ses/latest/dg/send-email-smtp-client-command-line.html#send-email-using-openssl) for full details
# API Reference
## Constructs
### SesSmtpCredentials
#### Initializers
```typescript
import { SesSmtpCredentials } from '@renovosolutions/cdk-library-aws-ses-smtp-credentials'
new SesSmtpCredentials(scope: Construct, id: string, props: SesSmtpCredentialsProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | SesSmtpCredentialsProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* SesSmtpCredentialsProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### ~~`isConstruct`~~
```typescript
import { SesSmtpCredentials } from '@renovosolutions/cdk-library-aws-ses-smtp-credentials'
SesSmtpCredentials.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| iamUser | aws-cdk-lib.aws_iam.User | The IAM user to which the SMTP credentials are attached. |
| secret | aws-cdk-lib.aws_secretsmanager.ISecret | The AWS secrets manager secret that contains the SMTP credentials. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `iamUser`Required
```typescript
public readonly iamUser: User;
```
- *Type:* aws-cdk-lib.aws_iam.User
The IAM user to which the SMTP credentials are attached.
---
##### `secret`Required
```typescript
public readonly secret: ISecret;
```
- *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
The AWS secrets manager secret that contains the SMTP credentials.
---
## Structs
### SesSmtpCredentialsProps
The properties of a new set of SMTP Credentials.
#### Initializer
```typescript
import { SesSmtpCredentialsProps } from '@renovosolutions/cdk-library-aws-ses-smtp-credentials'
const sesSmtpCredentialsProps: SesSmtpCredentialsProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| iamUserName | string | The name of the IAM user to create. |
| kmsKey | aws-cdk-lib.aws_kms.IKey | The KMS key to use for the secret. |
| overwriteSecret | boolean | If a secret already exists should it be overwritten? |
| restoreSecret | boolean | If a secret is pending deletion should it be restored? |
| secretResourcePolicy | aws-cdk-lib.aws_iam.PolicyDocument | The resource policy to apply to the resulting secret. |
---
##### `iamUserName`Required
```typescript
public readonly iamUserName: string;
```
- *Type:* string
The name of the IAM user to create.
---
##### `kmsKey`Optional
```typescript
public readonly kmsKey: IKey;
```
- *Type:* aws-cdk-lib.aws_kms.IKey
- *Default:* default key
The KMS key to use for the secret.
---
##### `overwriteSecret`Optional
```typescript
public readonly overwriteSecret: boolean;
```
- *Type:* boolean
- *Default:* true
If a secret already exists should it be overwritten?
This helps in cases where cloudformation creates a secret successfully but it gets orphaned for some reason.
---
##### `restoreSecret`Optional
```typescript
public readonly restoreSecret: boolean;
```
- *Type:* boolean
- *Default:* true
If a secret is pending deletion should it be restored?
This helps in cases where cloudformation roll backs puts a secret in pending delete state.
---
##### `secretResourcePolicy`Optional
```typescript
public readonly secretResourcePolicy: PolicyDocument;
```
- *Type:* aws-cdk-lib.aws_iam.PolicyDocument
The resource policy to apply to the resulting secret.
---