aws logo
AWS Classic v5.29.1, Feb 4 23

aws.autoscaling.Tag

Manages an individual Autoscaling Group (ASG) tag. This resource should only be used in cases where ASGs are created outside the provider (e.g., ASGs implicitly created by EKS Node Groups).

NOTE: This tagging resource should not be combined with the resource for managing the parent resource. For example, using aws.autoscaling.Group and aws.autoscaling.Tag to manage tags of the same ASG will cause a perpetual difference where the aws.autoscaling.Group resource will try to remove the tag being added by the aws.autoscaling.Tag resource.

NOTE: This tagging resource does not use the provider ignore_tags configuration.

Create Tag Resource

new Tag(name: string, args: TagArgs, opts?: CustomResourceOptions);
@overload
def Tag(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        autoscaling_group_name: Optional[str] = None,
        tag: Optional[TagTagArgs] = None)
@overload
def Tag(resource_name: str,
        args: TagArgs,
        opts: Optional[ResourceOptions] = None)
func NewTag(ctx *Context, name string, args TagArgs, opts ...ResourceOption) (*Tag, error)
public Tag(string name, TagArgs args, CustomResourceOptions? opts = null)
public Tag(String name, TagArgs args)
public Tag(String name, TagArgs args, CustomResourceOptions options)
type: aws:autoscaling:Tag
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args TagArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args TagArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args TagArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args TagArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args TagArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Tag Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Tag resource accepts the following input properties:

AutoscalingGroupName string

Name of the Autoscaling Group to apply the tag to.

TagDetails TagTagArgs

Tag to create. The tag block is documented below.

AutoscalingGroupName string

Name of the Autoscaling Group to apply the tag to.

Tag TagTagArgs

Tag to create. The tag block is documented below.

autoscalingGroupName String

Name of the Autoscaling Group to apply the tag to.

tag TagTagArgs

Tag to create. The tag block is documented below.

autoscalingGroupName string

Name of the Autoscaling Group to apply the tag to.

tag TagTagArgs

Tag to create. The tag block is documented below.

autoscaling_group_name str

Name of the Autoscaling Group to apply the tag to.

tag TagTagArgs

Tag to create. The tag block is documented below.

autoscalingGroupName String

Name of the Autoscaling Group to apply the tag to.

tag Property Map

Tag to create. The tag block is documented below.

Outputs

All input properties are implicitly available as output properties. Additionally, the Tag resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing Tag Resource

Get an existing Tag resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TagState, opts?: CustomResourceOptions): Tag
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        autoscaling_group_name: Optional[str] = None,
        tag: Optional[TagTagArgs] = None) -> Tag
func GetTag(ctx *Context, name string, id IDInput, state *TagState, opts ...ResourceOption) (*Tag, error)
public static Tag Get(string name, Input<string> id, TagState? state, CustomResourceOptions? opts = null)
public static Tag get(String name, Output<String> id, TagState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AutoscalingGroupName string

Name of the Autoscaling Group to apply the tag to.

TagDetails TagTagArgs

Tag to create. The tag block is documented below.

AutoscalingGroupName string

Name of the Autoscaling Group to apply the tag to.

Tag TagTagArgs

Tag to create. The tag block is documented below.

autoscalingGroupName String

Name of the Autoscaling Group to apply the tag to.

tag TagTagArgs

Tag to create. The tag block is documented below.

autoscalingGroupName string

Name of the Autoscaling Group to apply the tag to.

tag TagTagArgs

Tag to create. The tag block is documented below.

autoscaling_group_name str

Name of the Autoscaling Group to apply the tag to.

tag TagTagArgs

Tag to create. The tag block is documented below.

autoscalingGroupName String

Name of the Autoscaling Group to apply the tag to.

tag Property Map

Tag to create. The tag block is documented below.

Supporting Types

TagTag

Key string

Tag name.

PropagateAtLaunch bool

Whether to propagate the tags to instances launched by the ASG.

Value string

Tag value.

Key string

Tag name.

PropagateAtLaunch bool

Whether to propagate the tags to instances launched by the ASG.

Value string

Tag value.

key String

Tag name.

propagateAtLaunch Boolean

Whether to propagate the tags to instances launched by the ASG.

value String

Tag value.

key string

Tag name.

propagateAtLaunch boolean

Whether to propagate the tags to instances launched by the ASG.

value string

Tag value.

key str

Tag name.

propagate_at_launch bool

Whether to propagate the tags to instances launched by the ASG.

value str

Tag value.

key String

Tag name.

propagateAtLaunch Boolean

Whether to propagate the tags to instances launched by the ASG.

value String

Tag value.

Import

aws_autoscaling_group_tag can be imported by using the ASG name and key, separated by a comma (,), e.g.,

 $ pulumi import aws:autoscaling/tag:Tag example asg-example,k8s.io/cluster-autoscaler/node-template/label/eks.amazonaws.com/capacityType

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.