CopyImageRequest Class | AWS SDK for .NET V3

Container for the parameters to the CopyImage operation. Initiates an AMI copy operation. You must specify the source AMI ID and both the source and destination locations. The copy operation must be initiated in the destination Region.

CopyImage supports the following source to destination copies:

Region to Region
Region to Outpost
Parent Region to Local Zone
Local Zone to parent Region
Between Local Zones with the same parent Region (only supported for certain Local Zones)

CopyImage does not support the following source to destination copies:

Local Zone to non-parent Regions
Between Local Zones with different parent Regions
Local Zone to Outpost
Outpost to Local Zone
Outpost to Region
Between Outposts
Within same Outpost
Cross-partition copies (use CreateStoreImageTask instead)

Destination specification

Region to Region: The destination Region is the Region in which you initiate the copy operation.
Region to Outpost: Specify the destination using the DestinationOutpostArn parameter (the ARN of the Outpost)
Region to Local Zone, and Local Zone to Local Zone copies: Specify the destination using the DestinationAvailabilityZone parameter (the name of the destination Local Zone) or DestinationAvailabilityZoneId parameter (the ID of the destination Local Zone).

Snapshot encryption

Region to Outpost: Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region or the key that you specify. Outposts do not support unencrypted snapshots.
Region to Local Zone, and Local Zone to Local Zone: Not all Local Zones require encrypted snapshots. In Local Zones that require encrypted snapshots, backing snapshots are automatically encrypted during copy. In Local Zones where encryption is not required, snapshots retain their original encryption state (encrypted or unencrypted) by default.

For more information, including the required permissions for copying an AMI, see Copy an Amazon EC2 AMI in the Amazon EC2 User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.CopyImageRequest

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

Syntax

public class CopyImageRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The CopyImageRequest type exposes the following members

Constructors

	Name	Description
	CopyImageRequest()

Properties

Name	Type	Description
ClientToken	System.String	Gets and sets the property ClientToken. Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in Amazon EC2 API requests in the Amazon EC2 API Reference.
CopyImageTags	System.Boolean	Gets and sets the property CopyImageTags. Specifies whether to copy your user-defined AMI tags to the new AMI. The following tags are not be copied: System tags (prefixed with `aws:`) For public and shared AMIs, user-defined tags that are attached by other Amazon Web Services accounts Default: Your user-defined AMI tags are not copied.
Description	System.String	Gets and sets the property Description. A description for the new AMI.
DestinationAvailabilityZone	System.String	Gets and sets the property DestinationAvailabilityZone. The Local Zone for the new AMI (for example, `cn-north-1-pkx-1a`). Only one of `DestinationAvailabilityZone`, `DestinationAvailabilityZoneId`, or `DestinationOutpostArn` can be specified.
DestinationAvailabilityZoneId	System.String	Gets and sets the property DestinationAvailabilityZoneId. The ID of the Local Zone for the new AMI (for example, `cnn1-pkx1-az1`). Only one of `DestinationAvailabilityZone`, `DestinationAvailabilityZoneId`, or `DestinationOutpostArn` can be specified.
DestinationOutpostArn	System.String	Gets and sets the property DestinationOutpostArn. The Amazon Resource Name (ARN) of the Outpost for the new AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. For more information, see Copy AMIs from an Amazon Web Services Region to an Outpost in the Amazon EBS User Guide. Only one of `DestinationAvailabilityZone`, `DestinationAvailabilityZoneId`, or `DestinationOutpostArn` can be specified.
Encrypted	System.Boolean	Gets and sets the property Encrypted. Specifies whether to encrypt the snapshots of the copied image. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using `KmsKeyId`. For more information, see Use encryption with EBS-backed AMIs in the Amazon EC2 User Guide.
KmsKeyId	System.String	Gets and sets the property KmsKeyId. The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. If you specify a KMS key, you must also set the encrypted state to `true`. You can specify a KMS key using any of the following: Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Key alias. For example, alias/ExampleAlias. Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails. The specified KMS key must exist in the destination Region. Amazon EBS does not support asymmetric KMS keys.
Name	System.String	Gets and sets the property Name. The name of the new AMI.
SnapshotCopyCompletionDurationMinutes	System.Int64	Gets and sets the property SnapshotCopyCompletionDurationMinutes. Specify a completion duration, in 15 minute increments, to initiate a time-based AMI copy. The specified completion duration applies to each of the snapshots associated with the AMI. Each snapshot associated with the AMI will be completed within the specified completion duration, with copy throughput automatically adjusted for each snapshot based on its size to meet the timing target. If you do not specify a value, the AMI copy operation is completed on a best-effort basis. This parameter is not supported when copying an AMI to or from a Local Zone, or to an Outpost. For more information, see Time-based copies for Amazon EBS snapshots and EBS-backed AMIs.
SourceImageId	System.String	Gets and sets the property SourceImageId. The ID of the AMI to copy.
SourceRegion	System.String	Gets and sets the property SourceRegion. The name of the Region that contains the AMI to copy.
TagSpecifications	System.Collections.Generic.List<Amazon.EC2.Model.TagSpecification>	Gets and sets the property TagSpecifications. The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or both. To tag the new AMI, the value for `ResourceType` must be `image`. To tag the new snapshots, the value for `ResourceType` must be `snapshot`. The same tag is applied to all the new snapshots. If you specify other values for `ResourceType`, the request fails. To tag an AMI or snapshot after it has been created, see CreateTags.

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:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5