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

Creates a configuration that you can later provide to configure and start an AWS DMS Serverless replication. You can also provide options to validate the configuration inputs before you start the replication.

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

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

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

```
{
  "Type" : "AWS::DMS::ReplicationConfig",
  "Properties" : {
      "[ComputeConfig](#cfn-dms-replicationconfig-computeconfig)" : ComputeConfig,
      "[ReplicationConfigIdentifier](#cfn-dms-replicationconfig-replicationconfigidentifier)" : String,
      "[ReplicationSettings](#cfn-dms-replicationconfig-replicationsettings)" : Json,
      "[ReplicationType](#cfn-dms-replicationconfig-replicationtype)" : String,
      "[ResourceIdentifier](#cfn-dms-replicationconfig-resourceidentifier)" : String,
      "[SourceEndpointArn](#cfn-dms-replicationconfig-sourceendpointarn)" : String,
      "[SupplementalSettings](#cfn-dms-replicationconfig-supplementalsettings)" : Json,
      "[TableMappings](#cfn-dms-replicationconfig-tablemappings)" : Json,
      "[Tags](#cfn-dms-replicationconfig-tags)" : [ Tag, ... ],
      "[TargetEndpointArn](#cfn-dms-replicationconfig-targetendpointarn)" : String
    }
}
```

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

```
Type: AWS::DMS::ReplicationConfig
Properties:
  [ComputeConfig](#cfn-dms-replicationconfig-computeconfig): 
    ComputeConfig
  [ReplicationConfigIdentifier](#cfn-dms-replicationconfig-replicationconfigidentifier): String
  [ReplicationSettings](#cfn-dms-replicationconfig-replicationsettings): Json
  [ReplicationType](#cfn-dms-replicationconfig-replicationtype): String
  [ResourceIdentifier](#cfn-dms-replicationconfig-resourceidentifier): String
  [SourceEndpointArn](#cfn-dms-replicationconfig-sourceendpointarn): String
  [SupplementalSettings](#cfn-dms-replicationconfig-supplementalsettings): Json
  [TableMappings](#cfn-dms-replicationconfig-tablemappings): Json
  [Tags](#cfn-dms-replicationconfig-tags): 
    - Tag
  [TargetEndpointArn](#cfn-dms-replicationconfig-targetendpointarn): String
```

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

`ComputeConfig`  <a name="cfn-dms-replicationconfig-computeconfig"></a>
Configuration parameters for provisioning an AWS DMS Serverless replication.  
*Required*: Yes  
*Type*: [ComputeConfig](aws-properties-dms-replicationconfig-computeconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReplicationConfigIdentifier`  <a name="cfn-dms-replicationconfig-replicationconfigidentifier"></a>
A unique identifier that you want to use to create a `ReplicationConfigArn` that is returned as part of the output from this action. You can then pass this output `ReplicationConfigArn` as the value of the `ReplicationConfigArn` option for other actions to identify both AWS DMS Serverless replications and replication configurations that you want those actions to operate on. For some actions, you can also use either this unique identifier or a corresponding ARN in action filters to identify the specific replication and replication configuration to operate on.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReplicationSettings`  <a name="cfn-dms-replicationconfig-replicationsettings"></a>
Optional JSON settings for AWS DMS Serverless replications that are provisioned using this replication configuration. For example, see [ Change processing tuning settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.ChangeProcessingTuning.html).  
*Required*: No  
*Type*: Json  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReplicationType`  <a name="cfn-dms-replicationconfig-replicationtype"></a>
The type of AWS DMS Serverless replication to provision using this replication configuration.  
Possible values:  
+  `"full-load"` 
+  `"cdc"` 
+  `"full-load-and-cdc"` 
*Required*: Yes  
*Type*: String  
*Allowed values*: `full-load | full-load-and-cdc | cdc`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResourceIdentifier`  <a name="cfn-dms-replicationconfig-resourceidentifier"></a>
Optional unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see [ Fine-grained access control using resource names and tags](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.FineGrainedAccess).  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SourceEndpointArn`  <a name="cfn-dms-replicationconfig-sourceendpointarn"></a>
The Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SupplementalSettings`  <a name="cfn-dms-replicationconfig-supplementalsettings"></a>
Optional JSON settings for specifying supplemental data. For more information, see [ Specifying supplemental data for task settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html).  
*Required*: No  
*Type*: Json  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TableMappings`  <a name="cfn-dms-replicationconfig-tablemappings"></a>
JSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration. For more information, see [ Specifying table selection and transformations rules using JSON](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.SelectionTransformation.html).  
*Required*: Yes  
*Type*: Json  
*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-replicationconfig-tags"></a>
One or more optional tags associated with resources used by the AWS DMS Serverless replication. For more information, see [ Tagging resources in AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tagging.html).  
*Required*: No  
*Type*: Array of [Tag](aws-properties-dms-replicationconfig-tag.md)  
*Minimum*: `1`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetEndpointArn`  <a name="cfn-dms-replicationconfig-targetendpointarn"></a>
The Amazon Resource Name (ARN) of the target endpoint for this AWS DMS serverless replication configuration.  
*Required*: Yes  
*Type*: String  
*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-replicationconfig-return-values"></a>

### Ref
<a name="aws-resource-dms-replicationconfig-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-replicationconfig-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-replicationconfig-return-values-fn--getatt-fn--getatt"></a>

`ReplicationConfigArn`  <a name="ReplicationConfigArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of this AWS DMS Serverless replication configuration.

# AWS::DMS::ReplicationConfig ComputeConfig
<a name="aws-properties-dms-replicationconfig-computeconfig"></a>

Configuration parameters for provisioning an AWS DMS Serverless replication.

## Syntax
<a name="aws-properties-dms-replicationconfig-computeconfig-syntax"></a>

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

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

```
{
  "[AvailabilityZone](#cfn-dms-replicationconfig-computeconfig-availabilityzone)" : String,
  "[DnsNameServers](#cfn-dms-replicationconfig-computeconfig-dnsnameservers)" : String,
  "[KmsKeyId](#cfn-dms-replicationconfig-computeconfig-kmskeyid)" : String,
  "[MaxCapacityUnits](#cfn-dms-replicationconfig-computeconfig-maxcapacityunits)" : Integer,
  "[MinCapacityUnits](#cfn-dms-replicationconfig-computeconfig-mincapacityunits)" : Integer,
  "[MultiAZ](#cfn-dms-replicationconfig-computeconfig-multiaz)" : Boolean,
  "[PreferredMaintenanceWindow](#cfn-dms-replicationconfig-computeconfig-preferredmaintenancewindow)" : String,
  "[ReplicationSubnetGroupId](#cfn-dms-replicationconfig-computeconfig-replicationsubnetgroupid)" : String,
  "[VpcSecurityGroupIds](#cfn-dms-replicationconfig-computeconfig-vpcsecuritygroupids)" : [ String, ... ]
}
```

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

```
  [AvailabilityZone](#cfn-dms-replicationconfig-computeconfig-availabilityzone): String
  [DnsNameServers](#cfn-dms-replicationconfig-computeconfig-dnsnameservers): String
  [KmsKeyId](#cfn-dms-replicationconfig-computeconfig-kmskeyid): String
  [MaxCapacityUnits](#cfn-dms-replicationconfig-computeconfig-maxcapacityunits): Integer
  [MinCapacityUnits](#cfn-dms-replicationconfig-computeconfig-mincapacityunits): Integer
  [MultiAZ](#cfn-dms-replicationconfig-computeconfig-multiaz): Boolean
  [PreferredMaintenanceWindow](#cfn-dms-replicationconfig-computeconfig-preferredmaintenancewindow): String
  [ReplicationSubnetGroupId](#cfn-dms-replicationconfig-computeconfig-replicationsubnetgroupid): String
  [VpcSecurityGroupIds](#cfn-dms-replicationconfig-computeconfig-vpcsecuritygroupids): 
    - String
```

## Properties
<a name="aws-properties-dms-replicationconfig-computeconfig-properties"></a>

`AvailabilityZone`  <a name="cfn-dms-replicationconfig-computeconfig-availabilityzone"></a>
The Availability Zone where the AWS DMS Serverless replication using this configuration will run. The default value is a random, system-chosen Availability Zone in the configuration's AWS Region, for example, `"us-west-2"`. You can't set this parameter if the `MultiAZ` parameter is set to `true`.  
*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)

`DnsNameServers`  <a name="cfn-dms-replicationconfig-computeconfig-dnsnameservers"></a>
A list of custom DNS name servers supported for the AWS DMS Serverless replication to access your source or target database. This list overrides the default name servers supported by the AWS DMS Serverless replication. You can specify a comma-separated list of internet addresses for up to four DNS name servers. For example: `"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"`  
*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)

`KmsKeyId`  <a name="cfn-dms-replicationconfig-computeconfig-kmskeyid"></a>
An AWS Key Management Service (AWS KMS) key Amazon Resource Name (ARN) that is used to encrypt the data during AWS DMS Serverless replication.  
If you don't specify a value for the `KmsKeyId` parameter, AWS DMS uses your default encryption key.  
AWS KMS creates the default encryption key for your Amazon Web Services account. Your AWS account has a different default encryption key for each AWS Region.  
*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)

`MaxCapacityUnits`  <a name="cfn-dms-replicationconfig-computeconfig-maxcapacityunits"></a>
Specifies the maximum value of the AWS DMS capacity units (DCUs) for which a given AWS DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the maximum value that you can specify for AWS DMS Serverless is 384. The `MaxCapacityUnits` parameter is the only DCU parameter you are required to specify.  
*Required*: Yes  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MinCapacityUnits`  <a name="cfn-dms-replicationconfig-computeconfig-mincapacityunits"></a>
Specifies the minimum value of the AWS DMS capacity units (DCUs) for which a given AWS DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the minimum DCU value that you can specify for AWS DMS Serverless is 1. If you don't set this value, AWS DMS sets this parameter to the minimum DCU value allowed, 1. If there is no current source activity, AWS DMS scales down your replication until it reaches the value specified in `MinCapacityUnits`.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MultiAZ`  <a name="cfn-dms-replicationconfig-computeconfig-multiaz"></a>
Specifies whether the AWS DMS Serverless replication is a Multi-AZ deployment. You can't set the `AvailabilityZone` parameter if the `MultiAZ` parameter is set to `true`.  
*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)

`PreferredMaintenanceWindow`  <a name="cfn-dms-replicationconfig-computeconfig-preferredmaintenancewindow"></a>
The weekly time range during which system maintenance can occur for the AWS DMS Serverless replication, in Universal Coordinated Time (UTC). The format is `ddd:hh24:mi-ddd:hh24:mi`.  
The default is a 30-minute window selected at random from an 8-hour block of time per AWS Region. This maintenance occurs on a random day of the week. Valid values for days of the week include `Mon`, `Tue`, `Wed`, `Thu`, `Fri`, `Sat`, and `Sun`.  
Constraints include a minimum 30-minute window.  
*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)

`ReplicationSubnetGroupId`  <a name="cfn-dms-replicationconfig-computeconfig-replicationsubnetgroupid"></a>
Specifies a subnet group identifier to associate with the AWS DMS Serverless replication.  
*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)

`VpcSecurityGroupIds`  <a name="cfn-dms-replicationconfig-computeconfig-vpcsecuritygroupids"></a>
Specifies the virtual private cloud (VPC) security group to use with the AWS DMS Serverless replication. The VPC security group must work with the VPC containing the replication.  
*Required*: No  
*Type*: Array of 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::ReplicationConfig Tag
<a name="aws-properties-dms-replicationconfig-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-replicationconfig-tag-syntax"></a>

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

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

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

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

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

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

`Key`  <a name="cfn-dms-replicationconfig-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-replicationconfig-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*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)