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

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

AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi

aws.ec2.Tag

Explore with Pulumi AI

aws logo

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

AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi

    Manages an individual EC2 resource tag. This resource should only be used in cases where EC2 resources are created outside the provider (e.g. AMIs), being shared via Resource Access Manager (RAM), or implicitly created by other means (e.g. Transit Gateway VPN Attachments).

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.ec2transitgateway.TransitGateway("example", {});
    const exampleCustomerGateway = new aws.ec2.CustomerGateway("example", {
        bgpAsn: "65000",
        ipAddress: "172.0.0.1",
        type: "ipsec.1",
    });
    const exampleVpnConnection = new aws.ec2.VpnConnection("example", {
        customerGatewayId: exampleCustomerGateway.id,
        transitGatewayId: example.id,
        type: exampleCustomerGateway.type,
    });
    const exampleTag = new aws.ec2.Tag("example", {
        resourceId: exampleVpnConnection.transitGatewayAttachmentId,
        key: "Name",
        value: "Hello World",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.ec2transitgateway.TransitGateway("example")
    example_customer_gateway = aws.ec2.CustomerGateway("example",
        bgp_asn="65000",
        ip_address="172.0.0.1",
        type="ipsec.1")
    example_vpn_connection = aws.ec2.VpnConnection("example",
        customer_gateway_id=example_customer_gateway.id,
        transit_gateway_id=example.id,
        type=example_customer_gateway.type)
    example_tag = aws.ec2.Tag("example",
        resource_id=example_vpn_connection.transit_gateway_attachment_id,
        key="Name",
        value="Hello World")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2transitgateway"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := ec2transitgateway.NewTransitGateway(ctx, "example", nil)
    		if err != nil {
    			return err
    		}
    		exampleCustomerGateway, err := ec2.NewCustomerGateway(ctx, "example", &ec2.CustomerGatewayArgs{
    			BgpAsn:    pulumi.String("65000"),
    			IpAddress: pulumi.String("172.0.0.1"),
    			Type:      pulumi.String("ipsec.1"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleVpnConnection, err := ec2.NewVpnConnection(ctx, "example", &ec2.VpnConnectionArgs{
    			CustomerGatewayId: exampleCustomerGateway.ID(),
    			TransitGatewayId:  example.ID(),
    			Type:              exampleCustomerGateway.Type,
    		})
    		if err != nil {
    			return err
    		}
    		_, err = ec2.NewTag(ctx, "example", &ec2.TagArgs{
    			ResourceId: exampleVpnConnection.TransitGatewayAttachmentId,
    			Key:        pulumi.String("Name"),
    			Value:      pulumi.String("Hello World"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Ec2TransitGateway.TransitGateway("example");
    
        var exampleCustomerGateway = new Aws.Ec2.CustomerGateway("example", new()
        {
            BgpAsn = "65000",
            IpAddress = "172.0.0.1",
            Type = "ipsec.1",
        });
    
        var exampleVpnConnection = new Aws.Ec2.VpnConnection("example", new()
        {
            CustomerGatewayId = exampleCustomerGateway.Id,
            TransitGatewayId = example.Id,
            Type = exampleCustomerGateway.Type,
        });
    
        var exampleTag = new Aws.Ec2.Tag("example", new()
        {
            ResourceId = exampleVpnConnection.TransitGatewayAttachmentId,
            Key = "Name",
            Value = "Hello World",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.ec2transitgateway.TransitGateway;
    import com.pulumi.aws.ec2.CustomerGateway;
    import com.pulumi.aws.ec2.CustomerGatewayArgs;
    import com.pulumi.aws.ec2.VpnConnection;
    import com.pulumi.aws.ec2.VpnConnectionArgs;
    import com.pulumi.aws.ec2.Tag;
    import com.pulumi.aws.ec2.TagArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new TransitGateway("example");
    
            var exampleCustomerGateway = new CustomerGateway("exampleCustomerGateway", CustomerGatewayArgs.builder()
                .bgpAsn(65000)
                .ipAddress("172.0.0.1")
                .type("ipsec.1")
                .build());
    
            var exampleVpnConnection = new VpnConnection("exampleVpnConnection", VpnConnectionArgs.builder()
                .customerGatewayId(exampleCustomerGateway.id())
                .transitGatewayId(example.id())
                .type(exampleCustomerGateway.type())
                .build());
    
            var exampleTag = new Tag("exampleTag", TagArgs.builder()
                .resourceId(exampleVpnConnection.transitGatewayAttachmentId())
                .key("Name")
                .value("Hello World")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:ec2transitgateway:TransitGateway
      exampleCustomerGateway:
        type: aws:ec2:CustomerGateway
        name: example
        properties:
          bgpAsn: 65000
          ipAddress: 172.0.0.1
          type: ipsec.1
      exampleVpnConnection:
        type: aws:ec2:VpnConnection
        name: example
        properties:
          customerGatewayId: ${exampleCustomerGateway.id}
          transitGatewayId: ${example.id}
          type: ${exampleCustomerGateway.type}
      exampleTag:
        type: aws:ec2:Tag
        name: example
        properties:
          resourceId: ${exampleVpnConnection.transitGatewayAttachmentId}
          key: Name
          value: Hello World
    

    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,
            key: Optional[str] = None,
            resource_id: Optional[str] = None,
            value: Optional[str] = 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:ec2: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.

    Constructor example

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

    var exampletagResourceResourceFromEc2tag = new Aws.Ec2.Tag("exampletagResourceResourceFromEc2tag", new()
    {
        Key = "string",
        ResourceId = "string",
        Value = "string",
    });
    
    example, err := ec2.NewTag(ctx, "exampletagResourceResourceFromEc2tag", &ec2.TagArgs{
    	Key:        pulumi.String("string"),
    	ResourceId: pulumi.String("string"),
    	Value:      pulumi.String("string"),
    })
    
    var exampletagResourceResourceFromEc2tag = new Tag("exampletagResourceResourceFromEc2tag", TagArgs.builder()
        .key("string")
        .resourceId("string")
        .value("string")
        .build());
    
    exampletag_resource_resource_from_ec2tag = aws.ec2.Tag("exampletagResourceResourceFromEc2tag",
        key="string",
        resource_id="string",
        value="string")
    
    const exampletagResourceResourceFromEc2tag = new aws.ec2.Tag("exampletagResourceResourceFromEc2tag", {
        key: "string",
        resourceId: "string",
        value: "string",
    });
    
    type: aws:ec2:Tag
    properties:
        key: string
        resourceId: string
        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:

    Key string
    The tag name.
    ResourceId string
    The ID of the EC2 resource to manage the tag for.
    Value string
    The value of the tag.
    Key string
    The tag name.
    ResourceId string
    The ID of the EC2 resource to manage the tag for.
    Value string
    The value of the tag.
    key String
    The tag name.
    resourceId String
    The ID of the EC2 resource to manage the tag for.
    value String
    The value of the tag.
    key string
    The tag name.
    resourceId string
    The ID of the EC2 resource to manage the tag for.
    value string
    The value of the tag.
    key str
    The tag name.
    resource_id str
    The ID of the EC2 resource to manage the tag for.
    value str
    The value of the tag.
    key String
    The tag name.
    resourceId String
    The ID of the EC2 resource to manage the tag for.
    value String
    The value of the tag.

    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,
            key: Optional[str] = None,
            resource_id: Optional[str] = None,
            value: Optional[str] = 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:
    Key string
    The tag name.
    ResourceId string
    The ID of the EC2 resource to manage the tag for.
    Value string
    The value of the tag.
    Key string
    The tag name.
    ResourceId string
    The ID of the EC2 resource to manage the tag for.
    Value string
    The value of the tag.
    key String
    The tag name.
    resourceId String
    The ID of the EC2 resource to manage the tag for.
    value String
    The value of the tag.
    key string
    The tag name.
    resourceId string
    The ID of the EC2 resource to manage the tag for.
    value string
    The value of the tag.
    key str
    The tag name.
    resource_id str
    The ID of the EC2 resource to manage the tag for.
    value str
    The value of the tag.
    key String
    The tag name.
    resourceId String
    The ID of the EC2 resource to manage the tag for.
    value String
    The value of the tag.

    Import

    Using pulumi import, import aws_ec2_tag using the EC2 resource identifier and key, separated by a comma (,). For example:

    $ pulumi import aws:ec2/tag:Tag example tgw-attach-1234567890abcdef,Name
    

    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.45.0 published on Tuesday, Jul 16, 2024 by Pulumi