You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EC2::Types::ImportImageRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ImportImageRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  architecture: "String",
  client_data: {
    comment: "String",
    upload_end: Time.now,
    upload_size: 1.0,
    upload_start: Time.now,
  },
  client_token: "String",
  description: "String",
  disk_containers: [
    {
      description: "String",
      device_name: "String",
      format: "String",
      snapshot_id: "String",
      url: "String",
      user_bucket: {
        s3_bucket: "String",
        s3_key: "String",
      },
    },
  ],
  dry_run: false,
  hypervisor: "String",
  license_type: "String",
  platform: "String",
  role_name: "String",
}

Contains the parameters for ImportImage.

Instance Attribute Summary collapse

Instance Attribute Details

#architectureString

The architecture of the virtual machine.

Valid values: i386 | x86_64

Returns:

  • (String)

    The architecture of the virtual machine.

#client_dataTypes::ClientData

The client-specific data.

Returns:

#client_tokenString

The token to enable idempotency for VM import requests.

Returns:

  • (String)

    The token to enable idempotency for VM import requests.

#descriptionString

A description string for the import image task.

Returns:

  • (String)

    A description string for the import image task.

#disk_containersArray<Types::ImageDiskContainer>

Information about the disk containers.

Returns:

#dry_runBoolean

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.

Returns:

  • (Boolean)

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

#hypervisorString

The target hypervisor platform.

Valid values: xen

Returns:

  • (String)

    The target hypervisor platform.

#license_typeString

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

Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see Prerequisites in the VM Import/Export User Guide.

Valid values: AWS | BYOL

Returns:

  • (String)

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

#platformString

The operating system of the virtual machine.

Valid values: Windows | Linux

Returns:

  • (String)

    The operating system of the virtual machine.

#role_nameString

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

Returns:

  • (String)

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