Resource: awsTransferTag
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 awsTransferServer
and awsTransferTag
to manage tags of the same server will cause a perpetual difference where the awsTransferServer
resource will try to remove the tag being added by the awsTransferTag
resource.
\~> NOTE: This tagging resource does not use the provider ignoreTags
configuration.
Example Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
const awsTransferServerExample = new aws.transferServer.TransferServer(
this,
"example",
{
identityProviderType: "SERVICE_MANAGED",
}
);
new aws.transferTag.TransferTag(this, "hostname", {
key: "aws:transfer:customHostname",
resourceArn: awsTransferServerExample.arn,
value: "example.com",
});
new aws.transferTag.TransferTag(this, "zone_id", {
key: "aws:transfer:route53HostedZoneId",
resourceArn: awsTransferServerExample.arn,
value: "/hostedzone/MyHostedZoneId",
});
Argument Reference
The following arguments are supported:
resourceArn
- (Required) Amazon Resource Name (ARN) of the Transfer Family resource to tag.key
- (Required) Tag name.value
- (Required) Tag value.
Attributes Reference
In addition to all arguments above, the following attributes are exported:
id
- Transfer Family resource identifier and key, separated by a comma (,
)
Import
awsTransferTag
can be imported by using the Transfer Family resource identifier and key, separated by a comma (,
), e.g.,