README.yaml

#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: terraform-aws-ses
# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - email
  - ses
# Categories of this project
categories:
  - terraform-modules/notification
# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"
# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-ses
# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-aws-ses.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-ses/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-ses.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-ses/commits
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://slack.cloudposse.com
description: |-
  Terraform module to provision Simple Email Service on AWS.
# How to use this project
usage: |-
  This module creates a SES domain with IAM user that is able to send emails with it.
  If module is provided with Route53 Zone ID it can also create verification DNS records for domain and DKIM.

  For a complete example, see [examples/complete](examples/complete).

  For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest) (which tests and deploys the example on AWS), see [test](test).

  What's worth to note is that every AWS SES starts in Sandbox. Sending emails via it (emails not verified in AWS SES) is only allowed after support request.

  SES availability in regions can be checked in [latest AWS General Reference](https://docs.aws.amazon.com/general/latest/gr/ses.html)

# Example usage
#examples: |-
#  Example goes here...

# How to get started quickly
#quickstart: |-
#  Here's how to get started...

# Other files to include in this README from the project folder
include:
  - "docs/targets.md"
  - "docs/terraform.md"
# Contributors to this project
contributors: []