AmazonEC2Client.CopyImage Method (CopyImageRequest)

Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.

To copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and specify the destination Region using its endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.

To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination Outpost using DestinationOutpostArn. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon EC2 User Guide.

For more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the Amazon EC2 User Guide.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CopyImageAsync.

Namespace: Amazon.EC2
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

public virtual CopyImageResponse CopyImage(
         CopyImageRequest request
)

Parameters

request: Type: Amazon.EC2.Model.CopyImageRequest

Container for the necessary parameters to execute the CopyImage service method.

Return Value

Type: CopyImageResponse

The response from the CopyImage service method, as returned by EC2.

Examples

This example copies the specified AMI from the us-east-1 region to the current region.

To copy an AMI to another region


var client = new AmazonEC2Client();
var response = client.CopyImage(new CopyImageRequest 
{
    Description = "",
    Name = "My server",
    SourceImageId = "ami-5731123e",
    SourceRegion = "us-east-1"
});

string imageId = response.ImageId;

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

AmazonEC2Client.CopyImage (CopyImageRequest)