generated from cloud-gov/.github
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update brokerpak docs with better descriptions, formatting, and defaults
- Required parameters should not have defaults, or user input won't be required - Defaults for optional parameters can be specified in Terraform, removing some empty default artifacts in the documentation - The identity domain cannot be updated after creation, so enforce this with `prohibit_update`
- Loading branch information
1 parent
b42db3b
commit 6f045fc
Showing
1 changed file
with
15 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,43 +1,42 @@ | ||
version: 1 | ||
name: cg-smtp | ||
id: 260f2ead-b9e9-48b5-9a01-6e3097208ad7 | ||
description: SMTP service provided by Amazon Simple Email Service (SES) | ||
display_name: SMTP (using AWS SES) | ||
description: Send email from verified domains using Amazon Simple Email Service (SES). Supports SMTP and the SES HTTP API. | ||
display_name: AWS Simple Email Service | ||
image_url: https://example.com/icon.jpg | ||
documentation_url: https://aws.amazon.com/ses/ # todo | ||
provider_display_name: "" | ||
provider_display_name: "Cloud.gov" | ||
support_url: https://cloud.gov/contact/ | ||
tags: [aws, ses, smtp] | ||
plans: | ||
- name: base | ||
id: 35ffb84b-a898-442e-b5f9-0a6a5229827d | ||
description: Provision SMTP credentials for sending email from any user at a domain, like 'agency.gov'. | ||
description: Provision SMTP credentials for sending email from any user at a domain, like `agency.gov`. | ||
display_name: Send-only service | ||
provision: | ||
plan_inputs: | ||
user_inputs: | ||
- field_name: domain | ||
type: string | ||
default: "" | ||
details: Domain from which mail will be sent. For example, agency.gov. If left empty, a temporary cloud.gov subdomain will be generated. | ||
required: false | ||
prohibit_update: true | ||
details: Domain from which mail will be sent. For example, `agency.gov`. If left empty, a temporary cloud.gov subdomain will be generated. | ||
- field_name: dmarc_report_uri_aggregate | ||
type: string | ||
required: true | ||
default: "" | ||
details: The mailto URI to which DMARC aggregate reports should be sent. For example, 'mailto:[email protected]'. Reports are automatically sent to [email protected]. | ||
details: The mailto URI to which DMARC aggregate reports should be sent. For example, `mailto:[email protected]`. Reports are automatically sent to `[email protected]`. If you specify a domain and later update this parameter, remember to update your DNS with the new records in the `required_records` output. | ||
- field_name: dmarc_report_uri_failure | ||
type: string | ||
required: true | ||
default: "" | ||
details: The mailto URI to which DMARC individual message failure reports should be sent. For example, 'mailto:[email protected]'. | ||
details: The mailto URI to which DMARC individual message failure reports should be sent. For example, `mailto:[email protected]`. If you specify a domain and later update this parameter, remember to update your DNS with the new records in the `required_records` output. | ||
- field_name: enable_feedback_notifications | ||
type: boolean | ||
details: Flag to toggle creation of SNS topics for feedback notifications. | ||
default: false | ||
- field_name: mail_from_subdomain | ||
type: string | ||
default: "" | ||
details: Subdomain to use as the sending email server. | ||
required: false | ||
details: The custom MAIL FROM domain that you want the verified identity to use. See the [SES v2 API reference](https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_PutEmailIdentityMailFromAttributes.html) for requirements. | ||
- field_name: new_field | ||
required: true | ||
type: string | ||
|
@@ -93,10 +92,10 @@ provision: | |
details: If a domain was supplied, you must create these records in that zone in your DNS system. | ||
- field_name: dmarc_report_uri_aggregate | ||
type: string | ||
details: The mailto URI to which DMARC aggregate reports should be sent. For example, 'mailto:[email protected]'. Reports are automatically sent to [email protected]. | ||
details: The mailto URI to which DMARC aggregate reports should be sent. For example, `mailto:[email protected]`. Reports are automatically sent to `[email protected]`. | ||
- field_name: dmarc_report_uri_failure | ||
type: string | ||
details: The mailto URI to which DMARC individual message failure reports should be sent. For example, 'mailto:[email protected]'. | ||
details: The mailto URI to which DMARC individual message failure reports should be sent. For example, `mailto:[email protected]`. | ||
- field_name: instructions | ||
type: string | ||
details: Any further steps that you must take before using the service. | ||
|
@@ -105,7 +104,7 @@ provision: | |
details: ARN of the SES Configuration Set associated with the identity. Used to create bindings. | ||
- field_name: domain_arn | ||
type: string | ||
details: Instance SES domain identity (used when creating bindings) | ||
details: Instance SES domain identity. Used to create bindings. | ||
- field_name: bounce_topic_arn | ||
type: string | ||
details: ARN of the SNS topic receiving bounce feedback notifications. | ||
|
@@ -129,11 +128,10 @@ bind: | |
- field_name: source_ips | ||
type: array | ||
default: [] | ||
details: IP Ranges that requests to SES must come from. | ||
details: A list of IP ranges in CIDR format. If specified, requests made with this binding must originate from the specified ranges. By default, all requests are allowed. | ||
prohibit_update: false | ||
- field_name: notification_webhook | ||
type: string | ||
default: "" | ||
details: HTTPS endpoint to subscribe to feedback notifications. | ||
computed_inputs: | ||
- name: aws_access_key_id_govcloud | ||
|