Struct aws_sdk_ec2::operation::import_image::ImportImageInput

#[non_exhaustive]
pub struct ImportImageInput {

    pub architecture: Option<String>,
    pub client_data: Option<ClientData>,
    pub client_token: Option<String>,
    pub description: Option<String>,
    pub disk_containers: Option<Vec<ImageDiskContainer>>,
    pub dry_run: Option<bool>,
    pub encrypted: Option<bool>,
    pub hypervisor: Option<String>,
    pub kms_key_id: Option<String>,
    pub license_type: Option<String>,
    pub platform: Option<String>,
    pub role_name: Option<String>,
    pub license_specifications: Option<Vec<ImportImageLicenseConfigurationRequest>>,
    pub tag_specifications: Option<Vec<TagSpecification>>,
    pub usage_operation: Option<String>,
    pub boot_mode: Option<BootModeValues>,
}

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.

architecture: Option<String>

The architecture of the virtual machine.

Valid values: i386 | x86_64

client_data: Option<ClientData>

The client-specific data.

client_token: Option<String>

The token to enable idempotency for VM import requests.

description: Option<String>

A description string for the import image task.

disk_containers: Option<Vec<ImageDiskContainer>>

Information about the disk containers.

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.

encrypted: Option<bool>

Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

hypervisor: Option<String>

The target hypervisor platform.

Valid values: xen

kms_key_id: Option<String>

An identifier for the symmetric KMS key to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The KMS key identifier may be provided in any of the following formats:

• Key ID

• Key alias

• ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

• ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified KMS key must exist in the Region that the AMI is being copied to.

Amazon EBS does not support asymmetric KMS keys.

license_type: Option<String>

The license type to be used for the Amazon Machine Image (AMI) after importing.

Specify AWS to replace the source-system license with an Amazon Web Services license or BYOL to retain the source-system license. Leaving this parameter undefined is the same as choosing AWS when importing a Windows Server operating system, and the same as choosing BYOL when importing a Windows client operating system (such as Windows 10) or a Linux operating system.

To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as Amazon Web Services. For more information, see Prerequisites in the VM Import/Export User Guide.

platform: Option<String>

The operating system of the virtual machine. If you import a VM that is compatible with Unified Extensible Firmware Interface (UEFI) using an EBS snapshot, you must specify a value for the platform.

Valid values: Windows | Linux

role_name: Option<String>

The name of the role to use when not using the default role, 'vmimport'.

license_specifications: Option<Vec<ImportImageLicenseConfigurationRequest>>

The ARNs of the license configurations.

tag_specifications: Option<Vec<TagSpecification>>

The tags to apply to the import image task during creation.

usage_operation: Option<String>

The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.

boot_mode: Option<BootModeValues>

The boot mode of the virtual machine.

The uefi-preferred boot mode isn't supported for importing images. For more information, see Boot modes in the VM Import/Export User Guide.

Implementations

impl ImportImageInput

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

The architecture of the virtual machine.

Valid values: i386 | x86_64

pub fn client_data(&self) -> Option<&ClientData>

The client-specific data.

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

The token to enable idempotency for VM import requests.

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

A description string for the import image task.

pub fn disk_containers(&self) -> &[ImageDiskContainer]

Information about the disk containers.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .disk_containers.is_none().

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 encrypted(&self) -> Option<bool>

Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

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

The target hypervisor platform.

Valid values: xen

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

An identifier for the symmetric KMS key to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The KMS key identifier may be provided in any of the following formats:

• Key ID

• Key alias

• ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

• ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified KMS key must exist in the Region that the AMI is being copied to.

Amazon EBS does not support asymmetric KMS keys.

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

The license type to be used for the Amazon Machine Image (AMI) after importing.

Specify AWS to replace the source-system license with an Amazon Web Services license or BYOL to retain the source-system license. Leaving this parameter undefined is the same as choosing AWS when importing a Windows Server operating system, and the same as choosing BYOL when importing a Windows client operating system (such as Windows 10) or a Linux operating system.

To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as Amazon Web Services. For more information, see Prerequisites in the VM Import/Export User Guide.

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

The operating system of the virtual machine. If you import a VM that is compatible with Unified Extensible Firmware Interface (UEFI) using an EBS snapshot, you must specify a value for the platform.

Valid values: Windows | Linux

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

The name of the role to use when not using the default role, 'vmimport'.

pub fn license_specifications( &self ) -> &[ImportImageLicenseConfigurationRequest]

The ARNs of the license configurations.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .license_specifications.is_none().

pub fn tag_specifications(&self) -> &[TagSpecification]

The tags to apply to the import image task during creation.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tag_specifications.is_none().

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

The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.

pub fn boot_mode(&self) -> Option<&BootModeValues>

The boot mode of the virtual machine.

The uefi-preferred boot mode isn't supported for importing images. For more information, see Boot modes in the VM Import/Export User Guide.

impl ImportImageInput

pub fn builder() -> ImportImageInputBuilder

Creates a new builder-style object to manufacture ImportImageInput.

Trait Implementations

impl Clone for ImportImageInput

fn clone(&self) -> ImportImageInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImportImageInput

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

Formats the value using the given formatter.

impl PartialEq for ImportImageInput

fn eq(&self, other: &ImportImageInput) -> 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 ImportImageInput