1. Packages
  2. AWS Classic
  3. API Docs
  4. autoscaling
  5. Tag

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

aws.autoscaling.Tag

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

    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

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Tag(name: string, args: TagArgs, opts?: CustomResourceOptions);
    @overload
    def Tag(resource_name: str,
            args: TagArgs,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def Tag(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            autoscaling_group_name: Optional[str] = None,
            tag: Optional[TagTagArgs] = 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.
    
    

    Parameters

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    var tagResource = new Aws.AutoScaling.Tag("tagResource", new()
    {
        AutoscalingGroupName = "string",
        TagDetails = new Aws.AutoScaling.Inputs.TagTagArgs
        {
            Key = "string",
            PropagateAtLaunch = false,
            Value = "string",
        },
    });
    
    example, err := autoscaling.NewTag(ctx, "tagResource", &autoscaling.TagArgs{
    	AutoscalingGroupName: pulumi.String("string"),
    	Tag: &autoscaling.TagTagArgs{
    		Key:               pulumi.String("string"),
    		PropagateAtLaunch: pulumi.Bool(false),
    		Value:             pulumi.String("string"),
    	},
    })
    
    var tagResource = new Tag("tagResource", TagArgs.builder()
        .autoscalingGroupName("string")
        .tag(TagTagArgs.builder()
            .key("string")
            .propagateAtLaunch(false)
            .value("string")
            .build())
        .build());
    
    tag_resource = aws.autoscaling.Tag("tagResource",
        autoscaling_group_name="string",
        tag=aws.autoscaling.TagTagArgs(
            key="string",
            propagate_at_launch=False,
            value="string",
        ))
    
    const tagResource = new aws.autoscaling.Tag("tagResource", {
        autoscalingGroupName: "string",
        tag: {
            key: "string",
            propagateAtLaunch: false,
            value: "string",
        },
    });
    
    type: aws:autoscaling:Tag
    properties:
        autoscalingGroupName: string
        tag:
            key: string
            propagateAtLaunch: false
            value: string
    

    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 TagTag
    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 TagTag
    Tag to create. The tag block is documented below.
    autoscalingGroupName string
    Name of the Autoscaling Group to apply the tag to.
    tag TagTag
    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 TagTag
    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 TagTag
    Tag to create. The tag block is documented below.
    autoscalingGroupName string
    Name of the Autoscaling Group to apply the tag to.
    tag TagTag
    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, TagTagArgs

    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

    Using pulumi import, import aws_autoscaling_group_tag using the ASG name and key, separated by a comma (,). For example:

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi