Skip to content

Commit

Permalink
r/aws_transfer_tag: Call out usage to manager custom hostname system …
Browse files Browse the repository at this point in the history
…tags.
  • Loading branch information
ewbankkit committed Oct 7, 2022
1 parent 16f419a commit 8e62051
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
2 changes: 2 additions & 0 deletions website/docs/r/transfer_server.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Provides a AWS Transfer Server resource.

~> **NOTE on AWS IAM permissions:** If the `endpoint_type` is set to `VPC`, the `ec2:DescribeVpcEndpoints` and `ec2:ModifyVpcEndpoint` [actions](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonec2.html#amazonec2-actions-as-permissions) are used.

~> **NOTE:** Use the [`aws_transfer_tag`](transfer_tag.html) resource to manage the system tags used for [custom hostnames](https://docs.aws.amazon.com/transfer/latest/userguide/requirements-dns.html#tag-custom-hostname-cdk).

## Example Usage

### Basic
Expand Down
16 changes: 11 additions & 5 deletions website/docs/r/transfer_tag.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ description: |-

# Resource: aws_transfer_tag

Manages an individual Transfer Family resource tag. This resource should only be used in cases where Transfer Family resources are created outside Terraform (e.g., Servers without AWS Management Console).
Manages an individual Transfer Family resource tag. This resource should only be used in cases where Transfer Family resources are created outside Terraform (e.g., Servers without AWS Management Console) or the tag key has the `aws:` prefix.

~> **NOTE:** This tagging resource should not be combined with the Terraform resource for managing the parent resource. For example, using `aws_transfer_server` and `aws_transfer_tag` to manage tags of the same ASG will cause a perpetual difference where the `aws_transfer_server` resource will try to remove the tag being added by the `aws_transfer_tag` resource.
~> **NOTE:** This tagging resource should not be combined with the Terraform resource for managing the parent resource. For example, using `aws_transfer_server` and `aws_transfer_tag` to manage tags of the same server will cause a perpetual difference where the `aws_transfer_server` resource will try to remove the tag being added by the `aws_transfer_tag` resource.

~> **NOTE:** This tagging resource does not use the [provider `ignore_tags` configuration](/docs/providers/aws/index.html#ignore_tags).

Expand All @@ -21,10 +21,16 @@ resource "aws_transfer_server" "example" {
identity_provider_type = "SERVICE_MANAGED"
}
resource "aws_transfer_tag" "example" {
resource "aws_transfer_tag" "zone_id" {
resource_arn = aws_transfer_server.example.arn
key = "testkey"
value = "testvalue"
key = "aws:transfer:route53HostedZoneId"
value = "/hostedzone/MyHostedZoneId"
}
resource "aws_transfer_tag" "hostname" {
resource_arn = aws_transfer_server.example.arn
key = "aws:transfer:customHostname"
value = "example.com"
}
```

Expand Down

0 comments on commit 8e62051

Please sign in to comment.