CreateReplicationConfigurationTemplate - Application Migration Service

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", "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

Request to associate the default Application Migration Service Security group with the Replication Settings template.

Type: Boolean

Required: Yes

bandwidthThrottling

Request to configure bandwidth throttling during Replication Settings template creation.

Type: Long

Valid Range: Minimum value of 0.

Required: Yes

createPublicIP

Request to create Public IP during Replication Settings template creation.

Type: Boolean

Required: Yes

dataPlaneRouting

Request to configure data plane routing during Replication Settings template creation.

Type: String

Valid Values: PRIVATE_IP | PUBLIC_IP

Required: Yes

defaultLargeStagingDiskType

Request to configure the Staging Disk EBS volume type to "gp2" during Replication Settings template creation.

Type: String

Valid Values: GP2 | ST1

Required: Yes

ebsEncryption

Request to configure EBS enryption during Replication Settings template creation.

Type: String

Valid Values: DEFAULT | CUSTOM

Required: Yes

ebsEncryptionKeyArn

Request to configure an EBS enryption key during Replication Settings template creation.

Type: String

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

Required: No

replicationServerInstanceType

Request to configure the Replication Server instance type during Replication Settings template creation.

Type: String

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

Required: Yes

replicationServersSecurityGroupsIDs

Request to configure the Replication Server Secuirity group ID during Replication Settings template creation.

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

Request to configure the Staging Area subnet ID during Replication Settings template creation.

Type: String

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

Pattern: ^subnet-[0-9a-fA-F]{8,}$

Required: Yes

stagingAreaTags

Request to configure Staiging Area tags during Replication Settings template creation.

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

Request to configure tags during Replication Settings template creation.

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

Request to use Dedicated Replication Servers during Replication Settings template creation.

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", "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

Replication Configuration template ARN.

Type: String

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

associateDefaultSecurityGroup

Replication Configuration template associate default Application Migration Service Security group.

Type: Boolean

bandwidthThrottling

Replication Configuration template bandwidth throtting.

Type: Long

Valid Range: Minimum value of 0.

createPublicIP

Replication Configuration template create Public IP.

Type: Boolean

dataPlaneRouting

Replication Configuration template data plane routing.

Type: String

Valid Values: PRIVATE_IP | PUBLIC_IP

defaultLargeStagingDiskType

Replication Configuration template use dedault large Staging Disk type.

Type: String

Valid Values: GP2 | ST1

ebsEncryption

Replication Configuration template EBS encryption.

Type: String

Valid Values: DEFAULT | CUSTOM

ebsEncryptionKeyArn

Replication Configuration template EBS encryption key ARN.

Type: String

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

replicationConfigurationTemplateID

Replication Configuration template template ID.

Type: String

Length Constraints: Fixed length of 21.

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

replicationServerInstanceType

Replication Configuration template server instance type.

Type: String

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

replicationServersSecurityGroupsIDs

Replication Configuration template server Security Groups IDs.

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

Replication Configuration template Staging Area subnet ID.

Type: String

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

Pattern: ^subnet-[0-9a-fA-F]{8,}$

stagingAreaTags

Replication Configuration template Staging Area Tags.

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

Replication Configuration template Tags.

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

Replication Configuration template use Dedicated Replication Server.

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Operating denied due to a file permission or access check error.

HTTP Status Code: 403

UninitializedAccountException

Unitialized account exception.

HTTP Status Code: 400

ValidationException

Validate exception.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: