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
<a name="aws-resource-dms-datamigration"></a>

This object provides information about a AWS DMS data migration.

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

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

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

```
{
  "Type" : "AWS::DMS::DataMigration",
  "Properties" : {
      "[DataMigrationIdentifier](#cfn-dms-datamigration-datamigrationidentifier)" : String,
      "[DataMigrationName](#cfn-dms-datamigration-datamigrationname)" : String,
      "[DataMigrationSettings](#cfn-dms-datamigration-datamigrationsettings)" : DataMigrationSettings,
      "[DataMigrationType](#cfn-dms-datamigration-datamigrationtype)" : String,
      "[MigrationProjectIdentifier](#cfn-dms-datamigration-migrationprojectidentifier)" : String,
      "[ServiceAccessRoleArn](#cfn-dms-datamigration-serviceaccessrolearn)" : String,
      "[SourceDataSettings](#cfn-dms-datamigration-sourcedatasettings)" : [ SourceDataSettings, ... ],
      "[Tags](#cfn-dms-datamigration-tags)" : [ Tag, ... ]
    }
}
```

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

```
Type: AWS::DMS::DataMigration
Properties:
  [DataMigrationIdentifier](#cfn-dms-datamigration-datamigrationidentifier): String
  [DataMigrationName](#cfn-dms-datamigration-datamigrationname): String
  [DataMigrationSettings](#cfn-dms-datamigration-datamigrationsettings): 
    DataMigrationSettings
  [DataMigrationType](#cfn-dms-datamigration-datamigrationtype): String
  [MigrationProjectIdentifier](#cfn-dms-datamigration-migrationprojectidentifier): String
  [ServiceAccessRoleArn](#cfn-dms-datamigration-serviceaccessrolearn): String
  [SourceDataSettings](#cfn-dms-datamigration-sourcedatasettings): 
    - SourceDataSettings
  [Tags](#cfn-dms-datamigration-tags): 
    - Tag
```

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

`DataMigrationIdentifier`  <a name="cfn-dms-datamigration-datamigrationidentifier"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `300`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DataMigrationName`  <a name="cfn-dms-datamigration-datamigrationname"></a>
The user-friendly name for the data migration.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `300`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DataMigrationSettings`  <a name="cfn-dms-datamigration-datamigrationsettings"></a>
Specifies CloudWatch settings and selection rules for the data migration.  
*Required*: No  
*Type*: [DataMigrationSettings](aws-properties-dms-datamigration-datamigrationsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DataMigrationType`  <a name="cfn-dms-datamigration-datamigrationtype"></a>
Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `full-load | cdc | full-load-and-cdc`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MigrationProjectIdentifier`  <a name="cfn-dms-datamigration-migrationprojectidentifier"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServiceAccessRoleArn`  <a name="cfn-dms-datamigration-serviceaccessrolearn"></a>
The IAM role that the data migration uses to access AWS resources.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `300`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SourceDataSettings`  <a name="cfn-dms-datamigration-sourcedatasettings"></a>
Specifies information about the data migration's source data provider.  
*Required*: No  
*Type*: [Array](aws-properties-dms-datamigration-sourcedatasettings.md) of [SourceDataSettings](aws-properties-dms-datamigration-sourcedatasettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-dms-datamigration-tags"></a>
Property description not available.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-dms-datamigration-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-dms-datamigration-return-values"></a>

### Ref
<a name="aws-resource-dms-datamigration-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-dms-datamigration-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-dms-datamigration-return-values-fn--getatt-fn--getatt"></a>

`DataMigrationArn`  <a name="DataMigrationArn-fn::getatt"></a>
The Amazon Resource Name (ARN) that identifies this replication.

`DataMigrationCreateTime`  <a name="DataMigrationCreateTime-fn::getatt"></a>
The UTC time when DMS created the data migration.

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

Options for configuring a data migration, including whether to enable CloudWatch logs, and the selection rules to use to include or exclude database objects from the migration.

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

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

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

```
{
  "[CloudwatchLogsEnabled](#cfn-dms-datamigration-datamigrationsettings-cloudwatchlogsenabled)" : Boolean,
  "[NumberOfJobs](#cfn-dms-datamigration-datamigrationsettings-numberofjobs)" : Integer,
  "[SelectionRules](#cfn-dms-datamigration-datamigrationsettings-selectionrules)" : String
}
```

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

```
  [CloudwatchLogsEnabled](#cfn-dms-datamigration-datamigrationsettings-cloudwatchlogsenabled): Boolean
  [NumberOfJobs](#cfn-dms-datamigration-datamigrationsettings-numberofjobs): Integer
  [SelectionRules](#cfn-dms-datamigration-datamigrationsettings-selectionrules): String
```

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

`CloudwatchLogsEnabled`  <a name="cfn-dms-datamigration-datamigrationsettings-cloudwatchlogsenabled"></a>
Whether to enable CloudWatch logging for the data migration.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NumberOfJobs`  <a name="cfn-dms-datamigration-datamigrationsettings-numberofjobs"></a>
The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SelectionRules`  <a name="cfn-dms-datamigration-datamigrationsettings-selectionrules"></a>
A JSON-formatted string that defines what objects to include and exclude from the migration.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

<a name="aws-properties-dms-datamigration-sourcedatasettings-description"></a>The `SourceDataSettings` property type specifies Property description not available. for an [AWS::DMS::DataMigration](aws-resource-dms-datamigration.md).

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

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

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

```
{
  "[CDCStartPosition](#cfn-dms-datamigration-sourcedatasettings-cdcstartposition)" : String,
  "[CDCStartTime](#cfn-dms-datamigration-sourcedatasettings-cdcstarttime)" : String,
  "[CDCStopTime](#cfn-dms-datamigration-sourcedatasettings-cdcstoptime)" : String,
  "[SlotName](#cfn-dms-datamigration-sourcedatasettings-slotname)" : String
}
```

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

```
  [CDCStartPosition](#cfn-dms-datamigration-sourcedatasettings-cdcstartposition): String
  [CDCStartTime](#cfn-dms-datamigration-sourcedatasettings-cdcstarttime): String
  [CDCStopTime](#cfn-dms-datamigration-sourcedatasettings-cdcstoptime): String
  [SlotName](#cfn-dms-datamigration-sourcedatasettings-slotname): String
```

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

`CDCStartPosition`  <a name="cfn-dms-datamigration-sourcedatasettings-cdcstartposition"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Maximum*: `40`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CDCStartTime`  <a name="cfn-dms-datamigration-sourcedatasettings-cdcstarttime"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Maximum*: `40`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CDCStopTime`  <a name="cfn-dms-datamigration-sourcedatasettings-cdcstoptime"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Maximum*: `40`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SlotName`  <a name="cfn-dms-datamigration-sourcedatasettings-slotname"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# 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)