Skip to content

Commit ff687ed

Browse files
Merge pull request #174 from cloud-gov/aws-ses
Document new AWS SES service offering
2 parents a0fda38 + 1cf1021 commit ff687ed

3 files changed

Lines changed: 59 additions & 4 deletions

File tree

_data/services.yaml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
- name: aws-rds
22
page-name: relational-database
3-
description: "Persistent, relational databases using Amazon RDS"
3+
description: "Persistent, relational databases using Amazon RDS"
44
status: "Production"
55
source-code: https://github.com/cloud-gov/aws-broker
66
- name: aws-elasticache
77
description: AWS ElastiCache Redis 5.0.6 as a service
88
status: Production
99
- name: aws-elasticsearch
10-
description: AWS Elasticsearch 7.4 as a service
10+
description: AWS Elasticsearch 7.4 as a service
1111
status: Production
12+
- name: aws-ses
13+
description: AWS Simple Email Service
14+
status: Beta
15+
source-code: https://github.com/cloud-gov/csb
1216
- name: cdn-route
1317
description: "Custom domains, CDN caching, and TLS certificates with automatic renewal"
1418
status: "Deprecated"
@@ -19,7 +23,7 @@
1923
source-code: https://github.com/cloud-gov/external-domain-broker
2024
- name: cloud-gov-identity-provider
2125
description: "Authenticate cloud.gov users in your app"
22-
status: "Production"
26+
status: "Production"
2327
source-code: https://github.com/cloudfoundry-community/uaa-credentials-broker
2428
- name: cloud-gov-service-account
2529
description: "cloud.gov service accounts for automated access by programs"

content/docs/deployment/managed-services.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ cf share-service SERVICE-INSTANCE -s OTHER-SPACE [-o OTHER-ORG]
4343

4444
## Bind the service instance
4545

46-
For services that apply to an application ([Elasticsearch](/docs/services/aws-elasticsearch), [Redis](/docs/services/aws-elasticache), [relational databases (RDS)](/docs/services/relational-database), and [S3](/docs/services/s3)), the service instance must be bound to the application which will access it. (The [CDN service](/docs/services/cdn-route), [identity provider](/docs/services/cloud-gov-identity-provider), and [service account](/docs/services/cloud-gov-service-account) have different instructions, available in their service documentation.)
46+
For services that apply to an application ([Elasticsearch](/docs/services/aws-elasticsearch), [Redis](/docs/services/aws-elasticache), [relational databases (RDS)](/docs/services/relational-database), [SES](/docs/services/aws-ses) and [S3](/docs/services/s3)), the service instance must be bound to the application which will access it. (The [CDN service](/docs/services/cdn-route), [identity provider](/docs/services/cloud-gov-identity-provider), and [service account](/docs/services/cloud-gov-service-account) have different instructions, available in their service documentation.)
4747

4848
Binding to an application can be done in a single step by adding a binding to the application's `manifest.yml`, for example:
4949

content/docs/services/aws-ses.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
parent: services
3+
title: "AWS Simple Email Service"
4+
name: aws-ses
5+
description: "AWS SES: Send email from verified domains using SMTP or an HTTP API."
6+
status: "Beta"
7+
showInSidenav: true
8+
---
9+
10+
Cloud.gov offers [AWS SES](https://aws.amazon.com/ses/) as a service. SES is hosted in AWS GovCloud and supports sending emails via SMTP or the SES API.
11+
12+
## Usage and service plans
13+
14+
AWS SES currently offers one plan, `domain`. The `domain` plan supports sending email from a verified domain. You can provide a domain like `agency.gov` or allow Cloud.gov to generate a temporary domain for you.
15+
16+
If you provide a domain, you must create DNS records in your agency DNS system to send mail. Once the service instance is created, bind an application to it or create a service key. The binding or service key will include instructions for creating the required DNS records.
17+
18+
If you do not provide a domain, Cloud.gov will generate one. When generating a domain, Cloud.gov manages all DNS records, making this feature useful for testing and debugging.
19+
20+
For instructions on creating and binding to AWS SES service instances, examples, and the full plan and parameter reference, see [Cloud.gov Services Reference: AWS Simple Email Service](https://services.cloud.gov#aws-ses).
21+
22+
## Reputation protection
23+
24+
Cloud.gov monitors sender reputation on brokered SES identities. If bounce or complaint rates exceed a threshold, the identity's ability to send email will be disabled.
25+
26+
You must provide an administrative email via the `admin_email` parameter when creating an AWS SES instance. Cloud.gov will send warning notifications to this address if your identity is approaching the bounce or complaint threshold, and critical alarms if the identity has reached the threshold.
27+
28+
The thresholds are:
29+
30+
- Bounce rate, warning: 2%
31+
- Bounce rate, critical: 4%
32+
- Complaint rate, warning: 0.04%
33+
- Complaint rate, critical: 0.08%
34+
35+
These thresholds are based on AWS SES's reputation monitoring policies. For more information about monitoring sender reputation, see the [AWS Developer Guide](https://docs.aws.amazon.com/ses/latest/dg/monitor-sender-reputation.html).
36+
37+
To be notified of complaints, bounces, or successful delivery of emails sent from your identity, set `"enable_feedback_notifications": "true"` when creating your SES service instance and provide a webhook when binding. See [Cloud.gov Services Reference: AWS Simple Email Service](https://services.cloud.gov#aws-ses) for full details.
38+
39+
If sending is disabled on your domain, contact support@cloud.gov for help.
40+
41+
## Rotating credentials
42+
43+
Each service binding and service key creates a new IAM user with access to the identity. To rotate credentials, unbind and rebind your application to the service instance, or delete and recreate the service key.
44+
45+
## Feedback
46+
47+
AWS SES is new service currently offered as an invite-only beta. To get access to the beta, or provide feedback, email support@cloud.gov.
48+
49+
## The broker in GitHub
50+
51+
AWS SES is brokered using the [Cloud Service Broker project](https://github.com/cloudfoundry/cloud-service-broker/) from Cloud Foundry. Source code for Cloud.gov's implementation of the CSB and the SES brokerpak is [available on GitHub](https://github.com/cloud-gov/csb).

0 commit comments

Comments
 (0)