Struct aws_sdk_ec2::operation::import_image::builders::ImportImageFluentBuilder

pub struct ImportImageFluentBuilder { /* private fields */ }

Fluent builder constructing a request to ImportImage.

To import your virtual machines (VMs) with a console-based experience, you can use the Import virtual machine images to Amazon Web Services template in the Migration Hub Orchestrator console. For more information, see the Migration Hub Orchestrator User Guide .

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

Amazon Web Services VM Import/Export strongly recommends specifying a value for either the --license-type or --usage-operation parameter when you create a new VM Import task. This ensures your operating system is licensed appropriately and your billing is optimized.

For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.

Implementations

impl ImportImageFluentBuilder

pub fn as_input(&self) -> &ImportImageInputBuilder

Access the ImportImage as a reference.

pub async fn send( self ) -> Result<ImportImageOutput, SdkError<ImportImageError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<ImportImageOutput, ImportImageError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn architecture(self, input: impl Into<String>) -> Self

The architecture of the virtual machine.

Valid values: i386 | x86_64

pub fn set_architecture(self, input: Option<String>) -> Self

The architecture of the virtual machine.

Valid values: i386 | x86_64

pub fn get_architecture(&self) -> &Option<String>

The architecture of the virtual machine.

Valid values: i386 | x86_64

pub fn client_data(self, input: ClientData) -> Self

The client-specific data.

pub fn set_client_data(self, input: Option<ClientData>) -> Self

The client-specific data.

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

The client-specific data.

pub fn client_token(self, input: impl Into<String>) -> Self

The token to enable idempotency for VM import requests.

pub fn set_client_token(self, input: Option<String>) -> Self

The token to enable idempotency for VM import requests.

pub fn get_client_token(&self) -> &Option<String>

The token to enable idempotency for VM import requests.

pub fn description(self, input: impl Into<String>) -> Self

A description string for the import image task.

pub fn set_description(self, input: Option<String>) -> Self

A description string for the import image task.

pub fn get_description(&self) -> &Option<String>

A description string for the import image task.

pub fn disk_containers(self, input: ImageDiskContainer) -> Self

Appends an item to DiskContainers.

To override the contents of this collection use set_disk_containers.

Information about the disk containers.

pub fn set_disk_containers(self, input: Option<Vec<ImageDiskContainer>>) -> Self

Information about the disk containers.

pub fn get_disk_containers(&self) -> &Option<Vec<ImageDiskContainer>>

Information about the disk containers.

pub fn dry_run(self, input: bool) -> Self

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 set_dry_run(self, input: Option<bool>) -> Self

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 get_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, input: bool) -> Self

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 set_encrypted(self, input: Option<bool>) -> Self

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 get_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, input: impl Into<String>) -> Self

The target hypervisor platform.

Valid values: xen

pub fn set_hypervisor(self, input: Option<String>) -> Self

The target hypervisor platform.

Valid values: xen

pub fn get_hypervisor(&self) -> &Option<String>

The target hypervisor platform.

Valid values: xen

pub fn kms_key_id(self, input: impl Into<String>) -> Self

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 set_kms_key_id(self, input: Option<String>) -> Self

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 get_kms_key_id(&self) -> &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.

pub fn license_type(self, input: impl Into<String>) -> Self

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 set_license_type(self, input: Option<String>) -> Self

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 get_license_type(&self) -> &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.

pub fn platform(self, input: impl Into<String>) -> Self

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 set_platform(self, input: Option<String>) -> Self

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 get_platform(&self) -> &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

pub fn role_name(self, input: impl Into<String>) -> Self

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

pub fn set_role_name(self, input: Option<String>) -> Self

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

pub fn get_role_name(&self) -> &Option<String>

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

pub fn license_specifications( self, input: ImportImageLicenseConfigurationRequest ) -> Self

Appends an item to LicenseSpecifications.

To override the contents of this collection use set_license_specifications.

The ARNs of the license configurations.

pub fn set_license_specifications( self, input: Option<Vec<ImportImageLicenseConfigurationRequest>> ) -> Self

The ARNs of the license configurations.

pub fn get_license_specifications( &self ) -> &Option<Vec<ImportImageLicenseConfigurationRequest>>

The ARNs of the license configurations.

pub fn tag_specifications(self, input: TagSpecification) -> Self

Appends an item to TagSpecifications.

To override the contents of this collection use set_tag_specifications.

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

pub fn set_tag_specifications( self, input: Option<Vec<TagSpecification>> ) -> Self

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

pub fn get_tag_specifications(&self) -> &Option<Vec<TagSpecification>>

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

pub fn usage_operation(self, input: impl Into<String>) -> Self

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

pub fn set_usage_operation(self, input: Option<String>) -> Self

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

pub fn get_usage_operation(&self) -> &Option<String>

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

pub fn boot_mode(self, input: BootModeValues) -> Self

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.

pub fn set_boot_mode(self, input: Option<BootModeValues>) -> Self

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.

pub fn get_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.

Trait Implementations

impl Clone for ImportImageFluentBuilder

fn clone(&self) -> ImportImageFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImportImageFluentBuilder

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

Formats the value using the given formatter.