

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

# AWS::DMS::DataMigration Tag
<a name="aws-properties-dms-datamigration-tag"></a>

A user-defined key-value pair that describes metadata added to an AWS DMS resource and that is used by operations such as the following:
+  `AddTagsToResource` 
+  `ListTagsForResource` 
+  `RemoveTagsFromResource` 

## Syntax
<a name="aws-properties-dms-datamigration-tag-syntax"></a>

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

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

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

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

```
  [Key](#cfn-dms-datamigration-tag-key): String
  [Value](#cfn-dms-datamigration-tag-value): String
```

## Properties
<a name="aws-properties-dms-datamigration-tag-properties"></a>

`Key`  <a name="cfn-dms-datamigration-tag-key"></a>
A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '\$1', '.', '/', '=', '\$1', '-' (Java regular expressions: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-dms-datamigration-tag-value"></a>
A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '\$1', '.', '/', '=', '\$1', '-' (Java regular expressions: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)