UpdateReplicationConfigurationTemplate
Updates a ReplicationConfigurationTemplate by ID.
Request Syntax
POST /UpdateReplicationConfigurationTemplate HTTP/1.1 Content-type: application/json
{ "arn": "string",
"associateDefaultSecurityGroup": boolean, "bandwidthThrottling": number,
"createPublicIP": boolean, "dataPlaneRouting": "string",
"defaultLargeStagingDiskType": "string", "ebsEncryption": "string",
"ebsEncryptionKeyArn": "string", "pitPolicy": [
"replicationConfigurationTemplateID": "string", "replicationServerInstanceType": "string",
"replicationServersSecurityGroupsIDs": [ "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.
arn (p. 94)
The Replication Configuration Template ARN.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: ^arn:.{16,2044}$
Required: No
associateDefaultSecurityGroup (p. 94)
Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
Request Body Type: Boolean
Required: No
bandwidthThrottling (p. 94)
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 (p. 94)
Whether to create a Public IP for the Recovery Instance by default.
Type: Boolean Required: No
dataPlaneRouting (p. 94)
The data plane routing mechanism that will be used for replication.
Type: String
Valid Values: PRIVATE_IP | PUBLIC_IP Required: No
defaultLargeStagingDiskType (p. 94)
The Staging Disk EBS volume type to be used during replication.
Type: String
Valid Values: GP2 | GP3 | ST1 Required: No
ebsEncryption (p. 94)
The type of EBS encryption to be used during replication.
Type: String
Valid Values: DEFAULT | CUSTOM Required: No
ebsEncryptionKeyArn (p. 94)
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 pitPolicy (p. 94)
The Point in time (PIT) policy to manage snapshots taken during replication.
Request Body Type: Array of PITPolicyRule (p. 130) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
replicationConfigurationTemplateID (p. 94) The Replication Configuration Template ID.
Type: String
Length Constraints: Fixed length of 21.
Pattern: ^rct-[0-9a-zA-Z]{17}$
Required: Yes
replicationServerInstanceType (p. 94)
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 (p. 94)
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
stagingAreaSubnetId (p. 94)
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 (p. 94)
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.
Response Syntax Required: No
useDedicatedReplicationServer (p. 94)
Whether to use a dedicated Replication Server in the replication staging area.
Type: Boolean
"arn": "string",
"associateDefaultSecurityGroup": boolean, "bandwidthThrottling": number,
"createPublicIP": boolean, "dataPlaneRouting": "string",
"defaultLargeStagingDiskType": "string", "ebsEncryption": "string",
"ebsEncryptionKeyArn": "string", "pitPolicy": [
"replicationConfigurationTemplateID": "string", "replicationServerInstanceType": "string",
"replicationServersSecurityGroupsIDs": [ "string" ], "stagingAreaSubnetId": "string",
"stagingAreaTags": { "string" : "string"
},
"tags": {
"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.
arn (p. 97)
The Replication Configuration Template ARN.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: ^arn:.{16,2044}$
Response Elements associateDefaultSecurityGroup (p. 97)
Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
Type: Boolean
bandwidthThrottling (p. 97)
Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
Type: Long
Valid Range: Minimum value of 0.
createPublicIP (p. 97)
Whether to create a Public IP for the Recovery Instance by default.
Type: Boolean dataPlaneRouting (p. 97)
The data plane routing mechanism that will be used for replication.
Type: String
Valid Values: PRIVATE_IP | PUBLIC_IP defaultLargeStagingDiskType (p. 97)
The Staging Disk EBS volume type to be used during replication.
Type: String
Valid Values: GP2 | GP3 | ST1 ebsEncryption (p. 97)
The type of EBS encryption to be used during replication.
Type: String
Valid Values: DEFAULT | CUSTOM ebsEncryptionKeyArn (p. 97)
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}$
pitPolicy (p. 97)
The Point in time (PIT) policy to manage snapshots taken during replication.
Type: Array of PITPolicyRule (p. 130) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
replicationConfigurationTemplateID (p. 97) The Replication Configuration Template ID.
Type: String
Errors Length Constraints: Fixed length of 21.
Pattern: ^rct-[0-9a-zA-Z]{17}$
replicationServerInstanceType (p. 97)
The instance type to be used for the replication server.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
replicationServersSecurityGroupsIDs (p. 97)
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,}$
stagingAreaSubnetId (p. 97)
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 (p. 97)
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.
tags (p. 97)
A set of tags to be associated with the Replication Configuration Template resource.
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 (p. 97)
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 (p. 162).
See Also AccessDeniedException
TYou do not have sufficient access to perform this action.
HTTP Status Code: 403 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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3