Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . docdb ]



Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources. or in a Condition statement in an AWS Identity and Access Management (IAM) policy for Amazon DocumentDB.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--resource-name <value>
--tags <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--resource-name (string)

The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name (ARN).

--tags (list)

The tags to be assigned to the Amazon DocumentDB resource.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

    "Key": "string",
    "Value": "string"

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


To add one or more tags to a specified resource

The following add-tags-to-resource example adds three tags to sample-cluster. One tag (CropB) has a key name but no value.

aws docdb add-tags-to-resource \
    --resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \
    --tags Key="CropA",Value="Apple" Key="CropB" Key="CropC",Value="Corn"

This command produces no output.

For more information, see Tagging Amazon DocumentDB Resources in the Amazon DocumentDB Developer Guide.