Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cloudfront ]

tag-resource

Description

Add tags to a CloudFront resource.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--resource (string)

An ARN of a CloudFront resource.

--tags (structure)

A complex type that contains zero or more Tag elements.

Items -> (list)

A complex type that contains Tag elements.

(structure)

A complex type that contains Tag key and Tag value.

Key -> (string)

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z , A-Z , 0-9 , space, and the special characters _ - . : / = + @ .

Value -> (string)

A string that contains an optional Tag value.

The string length should be between 0 and 256 characters. Valid characters include a-z , A-Z , 0-9 , space, and the special characters _ - . : / = + @ .

Shorthand Syntax:

Items=[{Key=string,Value=string},{Key=string,Value=string}]

JSON Syntax:

{
  "Items": [
    {
      "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.

Examples

To tag a CloudFront distribution

The following tag-resource example adds two tags to the specified CloudFront distribution.

aws cloudfront tag-resource \
    --resource arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE \
    --tags 'Items=[{Key=Name,Value="Example name"},{Key=Project,Value="Example project"}]'

Instead of using command line arguments, you can provide the tags in a JSON file, as shown in the following example:

aws cloudfront tag-resource \
    --resource arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE \
    --tags file://tags.json

Contents of tags.json:

{
    "Items": [
        {
            "Key": "Name",
            "Value": "Example name"
        },
        {
            "Key": "Project",
            "Value": "Example project"
        }
    ]
}

This command produces no output.

Output

None