aws.dynamodb.Tag
Explore with Pulumi AI
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.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as std from "@pulumi/std";
const replica = aws.getRegion({});
const current = aws.getRegion({});
const example = new aws.dynamodb.Table("example", {replicas: [{
regionName: replica.then(replica => replica.name),
}]});
const test = new aws.dynamodb.Tag("test", {
resourceArn: pulumi.all([example.arn, current, replica]).apply(([arn, current, replica]) => std.replaceOutput({
text: arn,
search: current.name,
replace: replica.name,
})).apply(invoke => invoke.result),
key: "testkey",
value: "testvalue",
});
import pulumi
import pulumi_aws as aws
import pulumi_std as std
replica = aws.get_region()
current = aws.get_region()
example = aws.dynamodb.Table("example", replicas=[{
"region_name": replica.name,
}])
test = aws.dynamodb.Tag("test",
resource_arn=example.arn.apply(lambda arn: std.replace_output(text=arn,
search=current.name,
replace=replica.name)).apply(lambda invoke: invoke.result),
key="testkey",
value="testvalue")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/dynamodb"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
replica, err := aws.GetRegion(ctx, nil, nil)
if err != nil {
return err
}
current, err := aws.GetRegion(ctx, nil, nil)
if err != nil {
return err
}
example, err := dynamodb.NewTable(ctx, "example", &dynamodb.TableArgs{
Replicas: dynamodb.TableReplicaTypeArray{
&dynamodb.TableReplicaTypeArgs{
RegionName: pulumi.String(replica.Name),
},
},
})
if err != nil {
return err
}
_, err = dynamodb.NewTag(ctx, "test", &dynamodb.TagArgs{
ResourceArn: pulumi.String(example.Arn.ApplyT(func(arn string) (std.ReplaceResult, error) {
return std.ReplaceResult(interface{}(std.ReplaceOutput(ctx, std.ReplaceOutputArgs{
Text: arn,
Search: current.Name,
Replace: replica.Name,
}, nil))), nil
}).(std.ReplaceResultOutput).ApplyT(func(invoke std.ReplaceResult) (*string, error) {
return invoke.Result, nil
}).(pulumi.StringPtrOutput)),
Key: pulumi.String("testkey"),
Value: pulumi.String("testvalue"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
var replica = Aws.GetRegion.Invoke();
var current = Aws.GetRegion.Invoke();
var example = new Aws.DynamoDB.Table("example", new()
{
Replicas = new[]
{
new Aws.DynamoDB.Inputs.TableReplicaArgs
{
RegionName = replica.Apply(getRegionResult => getRegionResult.Name),
},
},
});
var test = new Aws.DynamoDB.Tag("test", new()
{
ResourceArn = Output.Tuple(example.Arn, current, replica).Apply(values =>
{
var arn = values.Item1;
var current = values.Item2;
var replica = values.Item3;
return Std.Replace.Invoke(new()
{
Text = arn,
Search = current.Apply(getRegionResult => getRegionResult.Name),
Replace = replica.Apply(getRegionResult => getRegionResult.Name),
});
}).Apply(invoke => invoke.Result),
Key = "testkey",
Value = "testvalue",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.AwsFunctions;
import com.pulumi.aws.inputs.GetRegionArgs;
import com.pulumi.aws.dynamodb.Table;
import com.pulumi.aws.dynamodb.TableArgs;
import com.pulumi.aws.dynamodb.inputs.TableReplicaArgs;
import com.pulumi.aws.dynamodb.Tag;
import com.pulumi.aws.dynamodb.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) {
final var replica = AwsFunctions.getRegion();
final var current = AwsFunctions.getRegion();
var example = new Table("example", TableArgs.builder()
.replicas(TableReplicaArgs.builder()
.regionName(replica.applyValue(getRegionResult -> getRegionResult.name()))
.build())
.build());
var test = new Tag("test", TagArgs.builder()
.resourceArn(example.arn().applyValue(arn -> StdFunctions.replace()).applyValue(invoke -> invoke.result()))
.key("testkey")
.value("testvalue")
.build());
}
}
resources:
example:
type: aws:dynamodb:Table
properties:
replicas:
- regionName: ${replica.name}
test:
type: aws:dynamodb:Tag
properties:
resourceArn:
fn::invoke:
Function: std:replace
Arguments:
text: ${example.arn}
search: ${current.name}
replace: ${replica.name}
Return: result
key: testkey
value: testvalue
variables:
replica:
fn::invoke:
Function: aws:getRegion
Arguments: {}
current:
fn::invoke:
Function: aws:getRegion
Arguments: {}
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)
type: aws:dynamodb: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 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 Tag("awsTagResource", 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:
- 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
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.