UpdateReplicationConfiguration
Allows you to update a ReplicationConfiguration by Source Server ID.
Request Syntax
POST /UpdateReplicationConfiguration HTTP/1.1
Content-type: application/json
{
"associateDefaultSecurityGroup": boolean,
"autoReplicateNewDisks": boolean,
"bandwidthThrottling": number,
"createPublicIP": boolean,
"dataPlaneRouting": "string",
"defaultLargeStagingDiskType": "string",
"ebsEncryption": "string",
"ebsEncryptionKeyArn": "string",
"name": "string",
"pitPolicy": [
{
"enabled": boolean,
"interval": number,
"retentionDuration": number,
"ruleID": number,
"units": "string"
}
],
"replicatedDisks": [
{
"deviceName": "string",
"iops": number,
"isBootDisk": boolean,
"optimizedStagingDiskType": "string",
"stagingDiskType": "string",
"throughput": number
}
],
"replicationServerInstanceType": "string",
"replicationServersSecurityGroupsIDs": [ "string" ],
"sourceServerID": "string",
"stagingAreaSubnetId": "string",
"stagingAreaTags": {
"string" : "string"
},
"useDedicatedReplicationServer": boolean
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- associateDefaultSecurityGroup
-
Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.
Type: Boolean
Required: No
- autoReplicateNewDisks
-
Whether to allow the AWS replication agent to automatically replicate newly added disks.
Type: Boolean
Required: No
- bandwidthThrottling
-
Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
Type: Long
Valid Range: Minimum value of 0.
Required: No
- createPublicIP
-
Whether to create a Public IP for the Recovery Instance by default.
Type: Boolean
Required: No
- dataPlaneRouting
-
The data plane routing mechanism that will be used for replication.
Type: String
Valid Values:
PRIVATE_IP | PUBLIC_IPRequired: No
- defaultLargeStagingDiskType
-
The Staging Disk EBS volume type to be used during replication.
Type: String
Valid Values:
GP2 | GP3 | ST1 | AUTORequired: No
- ebsEncryption
-
The type of EBS encryption to be used during replication.
Type: String
Valid Values:
DEFAULT | CUSTOM | NONERequired: No
- ebsEncryptionKeyArn
-
The ARN of the EBS encryption key to be used during replication.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:.{16,2044}$Required: No
- name
-
The name of the Replication Configuration.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Required: No
- pitPolicy
-
The Point in time (PIT) policy to manage snapshots taken during replication.
Type: Array of PITPolicyRule objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
- replicatedDisks
-
The configuration of the disks of the Source Server to be replicated.
Type: Array of ReplicationConfigurationReplicatedDisk objects
Array Members: Minimum number of 0 items. Maximum number of 60 items.
Required: No
- replicationServerInstanceType
-
The instance type to be used for the replication server.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Required: No
- replicationServersSecurityGroupsIDs
-
The security group IDs that will be used by the replication server.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 32 items.
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
^sg-[0-9a-fA-F]{8,}$Required: No
- sourceServerID
-
The ID of the Source Server for this Replication Configuration.
Type: String
Length Constraints: Fixed length of 19.
Pattern:
^s-[0-9a-zA-Z]{17}$Required: Yes
- stagingAreaSubnetId
-
The subnet to be used by the replication staging area.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
^subnet-[0-9a-fA-F]{8,}$Required: No
- stagingAreaTags
-
A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
Type: String to string map
Key Length Constraints: Minimum length of 0. Maximum length of 256.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
- useDedicatedReplicationServer
-
Whether to use a dedicated Replication Server in the replication staging area.
Type: Boolean
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"associateDefaultSecurityGroup": boolean,
"autoReplicateNewDisks": boolean,
"bandwidthThrottling": number,
"createPublicIP": boolean,
"dataPlaneRouting": "string",
"defaultLargeStagingDiskType": "string",
"ebsEncryption": "string",
"ebsEncryptionKeyArn": "string",
"name": "string",
"pitPolicy": [
{
"enabled": boolean,
"interval": number,
"retentionDuration": number,
"ruleID": number,
"units": "string"
}
],
"replicatedDisks": [
{
"deviceName": "string",
"iops": number,
"isBootDisk": boolean,
"optimizedStagingDiskType": "string",
"stagingDiskType": "string",
"throughput": number
}
],
"replicationServerInstanceType": "string",
"replicationServersSecurityGroupsIDs": [ "string" ],
"sourceServerID": "string",
"stagingAreaSubnetId": "string",
"stagingAreaTags": {
"string" : "string"
},
"useDedicatedReplicationServer": boolean
}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.
- associateDefaultSecurityGroup
-
Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.
Type: Boolean
- autoReplicateNewDisks
-
Whether to allow the AWS replication agent to automatically replicate newly added disks.
Type: Boolean
- bandwidthThrottling
-
Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
Type: Long
Valid Range: Minimum value of 0.
- createPublicIP
-
Whether to create a Public IP for the Recovery Instance by default.
Type: Boolean
- dataPlaneRouting
-
The data plane routing mechanism that will be used for replication.
Type: String
Valid Values:
PRIVATE_IP | PUBLIC_IP - defaultLargeStagingDiskType
-
The Staging Disk EBS volume type to be used during replication.
Type: String
Valid Values:
GP2 | GP3 | ST1 | AUTO - ebsEncryption
-
The type of EBS encryption to be used during replication.
Type: String
Valid Values:
DEFAULT | CUSTOM | NONE - ebsEncryptionKeyArn
-
The ARN of the EBS encryption key to be used during replication.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:.{16,2044}$ - name
-
The name of the Replication Configuration.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
- pitPolicy
-
The Point in time (PIT) policy to manage snapshots taken during replication.
Type: Array of PITPolicyRule objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
- replicatedDisks
-
The configuration of the disks of the Source Server to be replicated.
Type: Array of ReplicationConfigurationReplicatedDisk objects
Array Members: Minimum number of 0 items. Maximum number of 60 items.
- replicationServerInstanceType
-
The instance type to be used for the replication server.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
- replicationServersSecurityGroupsIDs
-
The security group IDs that will be used by the replication server.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 32 items.
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
^sg-[0-9a-fA-F]{8,}$ - sourceServerID
-
The ID of the Source Server for this Replication Configuration.
Type: String
Length Constraints: Fixed length of 19.
Pattern:
^s-[0-9a-zA-Z]{17}$ - stagingAreaSubnetId
-
The subnet to be used by the replication staging area.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
^subnet-[0-9a-fA-F]{8,}$ - stagingAreaTags
-
A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
Type: String to string map
Key Length Constraints: Minimum length of 0. Maximum length of 256.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
- useDedicatedReplicationServer
-
Whether to use a dedicated Replication Server in the replication staging area.
Type: Boolean
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
The request could not be completed due to a conflict with the current state of the target resource.
HTTP Status Code: 409
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource for this operation was not found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- UninitializedAccountException
-
The account performing the request has not been initialized.
HTTP Status Code: 400
- ValidationException
-
The input fails to satisfy the constraints specified by the AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
