AmazonCopyEbsVolumeParameters Object

Description

Parameters for the Amazon Copy EBS Volume action.

Properties

AttachToInstance

Indicates the EC2 instance details when the new EBS volume is to be attached to an EC2 instance.

Type: AttachVolumeToInstanceParameters object

Required: No

consistencyMethod

Consistency method to use when creating the EBS snapshot.

Type: string

Valid Values:

• none

• stop-instance

Required: No

Default: none

credentialIds

Registered credentials to use with the action. One and only one credential must be specified.

Type: Array of string

Required: Yes

regionNames

Regions to use with the action. One and only one region must be specified.

Type: Array of string

Required: Yes

volumeIdentificationMethod

Method in which EBS volumes will be selected.

Type: string

Valid Values:

• by-volume-id

Required: Yes

volumeId

ID of the EBS volume to be copied. Required when volumeIdentificationMethod is by-volume-id.

Type: string

Required: Conditional

Sample JSON

{
    "credentialIds": [
        "cred-00000001"
    ],
    "regionNames": [
        "us-east-1"
    ],

    "volumeIdentificationMethod": "by-volume-id",
    "volumeId": "vol-00000001",
    "consistencyMethod": "stop-instance",

    "attachToInstance": {
        "instanceIdentificationMethod": "by-instance-id",
        "instanceId": "i-00000001",
        "isDetachExistingDevice": true,
        "isStopInstance": true
    }
}