copySnapshot

inline suspend fun Ec2Client.copySnapshot(crossinline block: CopySnapshotRequest.Builder.() -> Unit): CopySnapshotResponse

Creates an exact copy of an Amazon EBS snapshot.

The location of the source snapshot determines whether you can copy it or not, and the allowed destinations for the snapshot copy.

  • If the source snapshot is in a Region, you can copy it within that Region, to another Region, to an Outpost associated with that Region, or to a Local Zone in that Region.

  • If the source snapshot is in a Local Zone, you can copy it within that Local Zone, to another Local Zone in the same zone group, or to the parent Region of the Local Zone.

  • If the source snapshot is on an Outpost, you can't copy it.

When copying snapshots to a Region, the encryption outcome for the snapshot copy depends on the Amazon EBS encryption by default setting for the destination Region, the encryption status of the source snapshot, and the encryption parameters you specify in the request. For more information, see Encryption and snapshot copying.

Snapshots copied to an Outpost must be encrypted. Unencrypted snapshots are not supported on Outposts. For more information, Amazon EBS local snapshots on Outposts.

Snapshots copies have an arbitrary source volume ID. Do not use this volume ID for any purpose.

For more information, see Copy an Amazon EBS snapshot in the Amazon EBS User Guide.

Samples


fun main() { 
   //sampleStart 
   // This example copies a snapshot with the snapshot ID of snap 066877671789bd71b from the us west 2
// region to the us east 1 region and adds a short description to identify the snapshot.
val resp = ec2Client.copySnapshot {
    sourceRegion = "us-west-2"
    sourceSnapshotId = "snap-066877671789bd71b"
    description = "This is my copied snapshot."
    destinationRegion = "us-east-1"
} 
   //sampleEnd
}