AWS::AutoScaling::AutoScalingGroup TagProperty - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::AutoScaling::AutoScalingGroup TagProperty

A structure that specifies a tag for the Tags property of AWS::AutoScaling::AutoScalingGroup resource.

For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide. You can find a sample template snippet in the Examples section of the AWS::AutoScaling::AutoScalingGroup resource.

CloudFormation adds the following tags to all Auto Scaling groups and associated instances:

  • aws:cloudformation:stack-name

  • aws:cloudformation:stack-id

  • aws:cloudformation:logical-id

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Key" : String,
  "PropagateAtLaunch" : Boolean,
  "Value" : String
}

YAML

  Key: String
  PropagateAtLaunch: Boolean
  Value: String

Properties

Key

The tag key.

Required: Yes

Type: String

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Minimum: 1

Maximum: 128

Update requires: No interruption

PropagateAtLaunch

Set to true if you want CloudFormation to copy the tag to EC2 instances that are launched as part of the Auto Scaling group. Set to false if you want the tag attached only to the Auto Scaling group and not copied to any instances launched as part of the Auto Scaling group.

Required: Yes

Type: Boolean

Update requires: No interruption

Value

The tag value.

Required: Yes

Type: String

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Minimum: 0

Maximum: 256

Update requires: No interruption