Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs/resource/aws_api_gateway_domain_name: Additional clarification of ACM vs IAM certificate usage #7886

Merged
merged 2 commits into from
Mar 14, 2019
Merged

docs/resource/aws_api_gateway_domain_name: Additional clarification of ACM vs IAM certificate usage #7886

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e21ae1
docs/resource/aws_api_gateway_domain_name: Additional clarification o…
bflad Mar 11, 2019
89588c0
docs/resource/aws_api_gateway_domain_name: Grammar fix
bflad Mar 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions website/docs/r/api_gateway_domain_name.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ description: |-

# aws_api_gateway_domain_name

Registers a custom domain name for use with AWS API Gateway.
Registers a custom domain name for use with AWS API Gateway. Additional information about this functionality
can be found in the [API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html).

This resource just establishes ownership of and the TLS settings for
a particular domain name. An API can be attached to a particular path
Expand All @@ -26,13 +27,13 @@ a distribution can be created if needed. In either case, it is necessary to crea
given domain name which is an alias (either Route53 alias or traditional CNAME) to the regional domain name exported in
the `regional_domain_name` attribute.

~> **Note:** API Gateway requires the use of AWS Certificate Manager (ACM) certificates instead of Identity and Access Management (IAM) certificates in regions that support ACM. Regions that support ACM can be found in the [Regions and Endpoints Documentation](https://docs.aws.amazon.com/general/latest/gr/rande.html#acm_region). To import an existing private key and certificate into ACM or request an ACM certificate, see the [`aws_acm_certificate` resource](/docs/providers/aws/r/acm_certificate.html).

~> **Note:** All arguments including the private key will be stored in the raw state as plain-text.
[Read more about sensitive data in state](/docs/state/sensitive-data.html).

## Example Usage

-> For information about regions that support AWS Certificate Manager (ACM), see the [Regions and Endpoints Documentation](https://docs.aws.amazon.com/general/latest/gr/rande.html#acm_region).

### Edge Optimized (ACM Certificate)

```hcl
Expand All @@ -56,7 +57,7 @@ resource "aws_route53_record" "example" {
}
```

### Edge Optimized (Uploaded Certificate)
### Edge Optimized (IAM Certificate)

```hcl
resource "aws_api_gateway_domain_name" "example" {
Expand Down Expand Up @@ -111,7 +112,7 @@ resource "aws_route53_record" "example" {
}
```

### Regional (Uploaded Certificate)
### Regional (IAM Certificate)

```hcl
resource "aws_api_gateway_domain_name" "example" {
Expand Down