AWS::EC2::LaunchTemplate TagSpecification
Specifies the tags to apply to a resource when the resource is created for the launch template.
TagSpecification
is a property type of TagSpecifications
.
TagSpecifications
is a property of AWS::EC2::LaunchTemplate LaunchTemplateData.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "ResourceType" :
String
, "Tags" :[ Tag, ... ]
}
YAML
ResourceType:
String
Tags:- Tag
Properties
-
The type of resource to tag.
Valid Values lists all resource types for Amazon EC2 that can be tagged. When you create a launch template, you can specify tags for the following resource types only:
instance
|volume
|network-interface
|spot-instances-request
. If the instance does not include the resource type that you specify, the instance launch fails. For example, not all instance types include a volume.To tag a resource after it has been created, see CreateTags.
Required: No
Type: String
Allowed values:
capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-virtual-interface | local-gateway-virtual-interface-group | local-gateway-route-table-vpc-association | local-gateway-route-table-virtual-interface-group-association | natgateway | network-acl | network-interface | network-insights-analysis | network-insights-path | network-insights-access-scope | network-insights-access-scope-analysis | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | volume | vpc | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log | capacity-reservation-fleet | traffic-mirror-filter-rule | vpc-endpoint-connection-device-type | verified-access-instance | verified-access-group | verified-access-endpoint | verified-access-policy | verified-access-trust-provider | vpn-connection-device-type | vpc-block-public-access-exclusion | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint
Update requires: No interruption
-
The tags to apply to the resource.
Required: No
Type: Array of Tag
Update requires: No interruption
Examples
The following example adds the tag Stack=Production
to the instances
created by the launch template.
YAML
TagSpecifications: - ResourceType: "instance" Tags: - Key: "Stack" Value: "Production"
JSON
"TagSpecifications": [ { "ResourceType": "instance", "Tags": [ { "Key": "Stack", "Value": "Production" } ] } ]
See also
-
LaunchTemplateTagSpecificationRequest in the Amazon EC2 API Reference