CreateReplicationConfigurationTemplate - AWS Elastic Disaster Recovery

CreateReplicationConfigurationTemplate

Creates a new ReplicationConfigurationTemplate.

Request Syntax

POST /CreateReplicationConfigurationTemplate HTTP/1.1 Content-type: application/json { "associateDefaultSecurityGroup": boolean, "bandwidthThrottling": number, "createPublicIP": boolean, "dataPlaneRouting": "string", "defaultLargeStagingDiskType": "string", "ebsEncryption": "string", "ebsEncryptionKeyArn": "string", "pitPolicy": [ { "enabled": boolean, "interval": number, "retentionDuration": number, "ruleID": number, "units": "string" } ], "replicationServerInstanceType": "string", "replicationServersSecurityGroupsIDs": [ "string" ], "stagingAreaSubnetId": "string", "stagingAreaTags": { "string" : "string" }, "tags": { "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 Template.

Type: Boolean

Required: Yes

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: Yes

createPublicIP

Whether to create a Public IP for the Recovery Instance by default.

Type: Boolean

Required: Yes

dataPlaneRouting

The data plane routing mechanism that will be used for replication.

Type: String

Valid Values: PRIVATE_IP | PUBLIC_IP

Required: Yes

defaultLargeStagingDiskType

The Staging Disk EBS volume type to be used during replication.

Type: String

Valid Values: GP2 | GP3 | ST1

Required: Yes

ebsEncryption

The type of EBS encryption to be used during replication.

Type: String

Valid Values: DEFAULT | CUSTOM

Required: Yes

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

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: Yes

replicationServerInstanceType

The instance type to be used for the replication server.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Required: Yes

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: 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: Yes

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: Yes

tags

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.

Required: No

useDedicatedReplicationServer

Whether to use a dedicated Replication Server in the replication staging area.

Type: Boolean

Required: Yes

Response Syntax

HTTP/1.1 201 Content-type: application/json { "arn": "string", "associateDefaultSecurityGroup": boolean, "bandwidthThrottling": number, "createPublicIP": boolean, "dataPlaneRouting": "string", "defaultLargeStagingDiskType": "string", "ebsEncryption": "string", "ebsEncryptionKeyArn": "string", "pitPolicy": [ { "enabled": boolean, "interval": number, "retentionDuration": number, "ruleID": number, "units": "string" } ], "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 201 response.

The following data is returned in JSON format by the service.

arn

The Replication Configuration Template ARN.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:.{16,2044}$

associateDefaultSecurityGroup

Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.

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

ebsEncryption

The type of EBS encryption to be used during replication.

Type: String

Valid Values: DEFAULT | CUSTOM

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}$

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.

replicationConfigurationTemplateID

The Replication Configuration Template ID.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^rct-[0-9a-zA-Z]{17}$

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,}$

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.

tags

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

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

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

ServiceQuotaExceededException

The request could not be completed because its exceeded the service quota.

HTTP Status Code: 402

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: