aws.dynamodb.Tag

Manages an individual DynamoDB resource tag. This resource should only be used in cases where DynamoDB resources are created outside the provider (e.g., Table replicas in other regions).

NOTE: This tagging resource should not be combined with the resource for managing the parent resource. For example, using aws.dynamodb.Table and aws.dynamodb.Tag to manage tags of the same DynamoDB Table in the same region will cause a perpetual difference where the aws_dynamodb_cluster resource will try to remove the tag being added by the aws.dynamodb.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,
        key: Optional[str] = None,
        resource_arn: 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:dynamodb:Tag
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

Constructor example

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

var awsTagResource = new Aws.DynamoDB.Tag("awsTagResource", new()
{
    Key = "string",
    ResourceArn = "string",
    Value = "string",
});

example, err := dynamodb.NewTag(ctx, "awsTagResource", &dynamodb.TagArgs{
	Key:         pulumi.String("string"),
	ResourceArn: pulumi.String("string"),
	Value:       pulumi.String("string"),
})

var awsTagResource = new com.pulumi.aws.dynamodb.Tag("awsTagResource", com.pulumi.aws.dynamodb.TagArgs.builder()
    .key("string")
    .resourceArn("string")
    .value("string")
    .build());

aws_tag_resource = aws.dynamodb.Tag("awsTagResource",
    key="string",
    resource_arn="string",
    value="string")

const awsTagResource = new aws.dynamodb.Tag("awsTagResource", {
    key: "string",
    resourceArn: "string",
    value: "string",
});

type: aws:dynamodb:Tag
properties:
    key: string
    resourceArn: 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:

Outputs

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

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_arn: 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)

resources:  _:    type: aws:dynamodb:Tag    get:      id: ${id}

Import

aws_dynamodb_tag can be imported by using the DynamoDB resource identifier and key, separated by a comma (,), e.g.,

 $ pulumi import aws:dynamodb/tag:Tag example arn:aws:dynamodb:us-east-1:123456789012:table/example,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.