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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass ImportImageRequest data as a 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)


14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14251

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :hypervisor,
  :license_type,
  :platform,
  :role_name)
  include Aws::Structure
end

#client_dataTypes::ClientData

The client-specific data.

Returns:



14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14251

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :hypervisor,
  :license_type,
  :platform,
  :role_name)
  include Aws::Structure
end

#client_tokenString

The token to enable idempotency for VM import requests.

Returns:

  • (String)


14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14251

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :hypervisor,
  :license_type,
  :platform,
  :role_name)
  include Aws::Structure
end

#descriptionString

A description string for the import image task.

Returns:

  • (String)


14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14251

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :hypervisor,
  :license_type,
  :platform,
  :role_name)
  include Aws::Structure
end

#disk_containersArray<Types::ImageDiskContainer>

Information about the disk containers.

Returns:



14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14251

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :hypervisor,
  :license_type,
  :platform,
  :role_name)
  include Aws::Structure
end

#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)


14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14251

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :hypervisor,
  :license_type,
  :platform,
  :role_name)
  include Aws::Structure
end

#hypervisorString

The target hypervisor platform.

Valid values: xen

Returns:

  • (String)


14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14251

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :hypervisor,
  :license_type,
  :platform,
  :role_name)
  include Aws::Structure
end

#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)


14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14251

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :hypervisor,
  :license_type,
  :platform,
  :role_name)
  include Aws::Structure
end

#platformString

The operating system of the virtual machine.

Valid values: Windows | Linux

Returns:

  • (String)


14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14251

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :hypervisor,
  :license_type,
  :platform,
  :role_name)
  include Aws::Structure
end

#role_nameString

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

Returns:

  • (String)


14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14251

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :hypervisor,
  :license_type,
  :platform,
  :role_name)
  include Aws::Structure
end