Struct aws_sdk_ec2::operation::copy_image::CopyImageInput

#[non_exhaustive]
pub struct CopyImageInput {
    pub client_token: Option<String>,
    pub description: Option<String>,
    pub encrypted: Option<bool>,
    pub kms_key_id: Option<String>,
    pub name: Option<String>,
    pub source_image_id: Option<String>,
    pub source_region: Option<String>,
    pub destination_outpost_arn: Option<String>,
    pub dry_run: Option<bool>,
    pub copy_image_tags: Option<bool>,
}

Contains the parameters for CopyImage.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

client_token: Option<String>

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

description: Option<String>

A description for the new AMI in the destination Region.

encrypted: Option<bool>

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 EC2 User Guide.

kms_key_id: Option<String>

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: Option<String>

The name of the new AMI in the destination Region.

source_image_id: Option<String>

The ID of the AMI to copy.

source_region: Option<String>

The name of the Region that contains the AMI to copy.

destination_outpost_arn: Option<String>

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 EC2 User Guide.

dry_run: Option<bool>

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

copy_image_tags: Option<bool>

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.

Implementations

impl CopyImageInput

pub fn client_token(&self) -> Option<&str>

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

pub fn description(&self) -> Option<&str>

A description for the new AMI in the destination Region.

pub fn encrypted(&self) -> Option<bool>

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 EC2 User Guide.

pub fn kms_key_id(&self) -> Option<&str>

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.

pub fn name(&self) -> Option<&str>

The name of the new AMI in the destination Region.

pub fn source_image_id(&self) -> Option<&str>

The ID of the AMI to copy.

pub fn source_region(&self) -> Option<&str>

The name of the Region that contains the AMI to copy.

pub fn destination_outpost_arn(&self) -> Option<&str>

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 EC2 User Guide.

pub fn dry_run(&self) -> Option<bool>

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

pub fn copy_image_tags(&self) -> Option<bool>

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.

impl CopyImageInput

pub fn builder() -> CopyImageInputBuilder

Creates a new builder-style object to manufacture CopyImageInput.

Trait Implementations

impl Clone for CopyImageInput

fn clone(&self) -> CopyImageInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CopyImageInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<CopyImageInput> for CopyImageInput

fn eq(&self, other: &CopyImageInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CopyImageInput