

This is the new *Amazon CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [Amazon CloudFormation User Guide](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::SSM::Document Tag
<a name="aws-properties-ssm-document-tag"></a>

Metadata that you assign to your Amazon resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Amazon Systems Manager, you can apply tags to Systems Manager documents (SSM documents), managed nodes, maintenance windows, parameters, patch baselines, OpsItems, and OpsMetadata.

## Syntax
<a name="aws-properties-ssm-document-tag-syntax"></a>

To declare this entity in your Amazon CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-ssm-document-tag-syntax.json"></a>

```
{
  "[Key](#cfn-ssm-document-tag-key)" : String,
  "[Value](#cfn-ssm-document-tag-value)" : String
}
```

### YAML
<a name="aws-properties-ssm-document-tag-syntax.yaml"></a>

```
  [Key](#cfn-ssm-document-tag-key): String
  [Value](#cfn-ssm-document-tag-value): String
```

## Properties
<a name="aws-properties-ssm-document-tag-properties"></a>

`Key`  <a name="cfn-ssm-document-tag-key"></a>
The name of the tag.  
*Required*: No  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-ssm-document-tag-value"></a>
The value of the tag.  
*Required*: No  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)