CopyImageRequest Class | AWS SDK for .NET V3

Container for the parameters to the CopyImage operation. 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 EBS User Guide.

For more information about the prerequisites and limits when copying an AMI, see Copy an 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 the Amazon EC2 API Reference.
CopyImageTags	System.Boolean	Gets and sets the property CopyImageTags. Indicates whether to include your user-defined AMI tags when copying the AMI. The following tags will 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 in the destination Region.
DestinationOutpostArn	System.String	Gets and sets the property DestinationOutpostArn. The Amazon Resource Name (ARN) of the Outpost to which to copy the 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 cannot 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.
Encrypted	System.Boolean	Gets and sets the property Encrypted. Specifies whether the destination snapshots of the copied image should be encrypted. 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 Amazon EBS encryption in the Amazon EBS 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 in the destination Region.
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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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