CreateReplicationConfig
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.
Request Syntax
{
"ComputeConfig": {
"AvailabilityZone": "string
",
"DnsNameServers": "string
",
"KmsKeyId": "string
",
"MaxCapacityUnits": number
,
"MinCapacityUnits": number
,
"MultiAZ": boolean
,
"PreferredMaintenanceWindow": "string
",
"ReplicationSubnetGroupId": "string
",
"VpcSecurityGroupIds": [ "string
" ]
},
"ReplicationConfigIdentifier": "string
",
"ReplicationSettings": "string
",
"ReplicationType": "string
",
"ResourceIdentifier": "string
",
"SourceEndpointArn": "string
",
"SupplementalSettings": "string
",
"TableMappings": "string
",
"Tags": [
{
"Key": "string
",
"ResourceArn": "string
",
"Value": "string
"
}
],
"TargetEndpointArn": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ComputeConfig
-
Configuration parameters for provisioning an AWS DMS Serverless replication.
Type: ComputeConfig object
Required: Yes
- ReplicationConfigIdentifier
-
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 outputReplicationConfigArn
as the value of theReplicationConfigArn
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.Type: String
Required: Yes
- ReplicationSettings
-
Optional JSON settings for AWS DMS Serverless replications that are provisioned using this replication configuration. For example, see Change processing tuning settings.
Type: String
Required: No
- ReplicationType
-
The type of AWS DMS Serverless replication to provision using this replication configuration.
Possible values:
-
"full-load"
-
"cdc"
-
"full-load-and-cdc"
Type: String
Valid Values:
full-load | cdc | full-load-and-cdc
Required: Yes
-
- ResourceIdentifier
-
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.
Type: String
Required: No
- SourceEndpointArn
-
The Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration.
Type: String
Required: Yes
- SupplementalSettings
-
Optional JSON settings for specifying supplemental data. For more information, see Specifying supplemental data for task settings.
Type: String
Required: No
- TableMappings
-
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.
Type: String
Required: Yes
- Tags
-
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.
Type: Array of Tag objects
Required: No
- TargetEndpointArn
-
The Amazon Resource Name (ARN) of the target endpoint for this AWS DMS serverless replication configuration.
Type: String
Required: Yes
Response Syntax
{
"ReplicationConfig": {
"ComputeConfig": {
"AvailabilityZone": "string",
"DnsNameServers": "string",
"KmsKeyId": "string",
"MaxCapacityUnits": number,
"MinCapacityUnits": number,
"MultiAZ": boolean,
"PreferredMaintenanceWindow": "string",
"ReplicationSubnetGroupId": "string",
"VpcSecurityGroupIds": [ "string" ]
},
"ReplicationConfigArn": "string",
"ReplicationConfigCreateTime": number,
"ReplicationConfigIdentifier": "string",
"ReplicationConfigUpdateTime": number,
"ReplicationSettings": "string",
"ReplicationType": "string",
"SourceEndpointArn": "string",
"SupplementalSettings": "string",
"TableMappings": "string",
"TargetEndpointArn": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ReplicationConfig
-
Configuration parameters returned from the AWS DMS Serverless replication after it is created.
Type: ReplicationConfig object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedFault
-
AWS DMS was denied access to the endpoint. Check that the role is correctly configured.
HTTP Status Code: 400
- InvalidResourceStateFault
-
The resource is in a state that prevents it from being used for database migration.
HTTP Status Code: 400
- InvalidSubnet
-
The subnet provided isn't valid.
HTTP Status Code: 400
- KMSKeyNotAccessibleFault
-
AWS DMS cannot access the KMS key.
HTTP Status Code: 400
- ReplicationSubnetGroupDoesNotCoverEnoughAZs
-
The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.
HTTP Status Code: 400
- ResourceAlreadyExistsFault
-
The resource you are attempting to create already exists.
HTTP Status Code: 400
- ResourceNotFoundFault
-
The resource could not be found.
HTTP Status Code: 400
- ResourceQuotaExceededFault
-
The quota for this resource quota has been exceeded.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of CreateReplicationConfig.
Sample Request
POST / HTTP/1.1
Host: dms.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>,
SignedHeaders=contenttype;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid,Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AmazonDMSv20160101.CreateReplicationConfig
{
"ReplicationConfigIdentifier":"test-replication-config",
"SourceEndpointArn":"arn:aws:dms:us-east-1:123456789012:endpoint:RZZK4EZW5UANC7Y3P4E776WHBE",
"TargetEndpointArn":"arn:aws:dms:us-east-1:123456789012:endpoint:GVBUJQXJZASXWHTWCLN2WNT57E",
"ComputeConfig": "{\"MaxCapacityUnits\":2}",
"ReplicationType": "full-load",
"TableMappings":"{\n \"TableMappings\": [ \n
{\n \"Type\": \"Include\",\n \"SourceSchema\": \"/\",
\n \"SourceTable\": \"/ \"\n }\n ]\n
}\n\n",
"ReplicationTaskSettings":"",
"Tags":[
{
"Key":"",
"Value":""
}
]
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
"ReplicationConfigIdentifier":"test-replication-config",
"ReplicationConfigArn":"arn:aws:dms:us-east-
1:123456789012:replication-config:UX6OL6MHMMJKFFOXE3H7LLJCMEKBDUG4ZV7DRSI",
"SourceEndpointArn":"arn:aws:dms:us-east-
1:123456789012:endpoint:RZZK4EZW5UANC7Y3P4E776WHBE",
"TargetEndpointArn":"arn:aws:dms:us-east-
1:123456789012:endpoint:GVBUJQXJZASXWHTWCLN2WNT57E",
"ReplicationConfigCreateTime":1677683717.524,
"TableMappings":"{\n \"TableMappings\": [ \n
{\n \"Type\": \"Include\",\n \"SourceSchema\": \"/\",
\n \"SourceTable\": \"/ \"\n }\n ]\n
}\n\n",
"ReplicationTaskSettings":"{\"TargetMetadata\":
{
\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":
true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":
false,\"LobMaxSize\":0},\"FullLoadSettings\":{
\"FullLoadEnabled\":true,
\"TargetTablePrepMode\":\"DROP_AND_CREATE\",
\"CreatePkAfterFullLoad\":false,
\"StopTaskCachedChangesApplied\":false,
\"StopTaskCachedChangesNotApplied\":false,
\"ResumeEnabled\":false,
\"ResumeMinTableSize\":100000,
\"ResumeOnlyClusteredPKTables\":true,
\"MaxFullLoadSubTasks\":8,
\"TransactionConsistencyTimeout\":600,
\"CommitRate\":10000
},
\"Logging\":{
\"EnableLogging\":false
}
}"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: