Try AWS Native preview for resources not in the classic version.
aws.dynamodb.Tag
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
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
andaws.dynamodb.Tag
to manage tags of the same DynamoDB Table in the same region will cause a perpetual difference where theaws_dynamodb_cluster
resource will try to remove the tag being added by theaws.dynamodb.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,
key: Optional[str] = None,
resource_arn: Optional[str] = None,
value: Optional[str] = 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)
type: aws:dynamodb: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:
- Key string
Tag name.
- Resource
Arn string Amazon Resource Name (ARN) of the DynamoDB resource to tag.
- Value string
Tag value.
- Key string
Tag name.
- Resource
Arn string Amazon Resource Name (ARN) of the DynamoDB resource to tag.
- Value string
Tag value.
- key String
Tag name.
- resource
Arn String Amazon Resource Name (ARN) of the DynamoDB resource to tag.
- value String
Tag value.
- key string
Tag name.
- resource
Arn string Amazon Resource Name (ARN) of the DynamoDB resource to tag.
- value string
Tag value.
- key str
Tag name.
- resource_
arn str Amazon Resource Name (ARN) of the DynamoDB resource to tag.
- value str
Tag value.
- key String
Tag name.
- resource
Arn String Amazon Resource Name (ARN) of the DynamoDB resource to tag.
- value String
Tag value.
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_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)
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.
- Key string
Tag name.
- Resource
Arn string Amazon Resource Name (ARN) of the DynamoDB resource to tag.
- Value string
Tag value.
- Key string
Tag name.
- Resource
Arn string Amazon Resource Name (ARN) of the DynamoDB resource to tag.
- Value string
Tag value.
- key String
Tag name.
- resource
Arn String Amazon Resource Name (ARN) of the DynamoDB resource to tag.
- value String
Tag value.
- key string
Tag name.
- resource
Arn string Amazon Resource Name (ARN) of the DynamoDB resource to tag.
- value string
Tag value.
- key str
Tag name.
- resource_
arn str Amazon Resource Name (ARN) of the DynamoDB resource to tag.
- value str
Tag value.
- key String
Tag name.
- resource
Arn String Amazon Resource Name (ARN) of the DynamoDB resource to tag.
- value String
Tag value.
Import
Using pulumi import
, import aws_dynamodb_tag
using the DynamoDB resource identifier and key, separated by a comma (,
). For example:
$ pulumi import aws:dynamodb/tag:Tag example arn:aws:dynamodb:us-east-1:123456789012:table/example,Name
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.