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,
  encrypted: false,
  hypervisor: "String",
  kms_key_id: "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 | arm64

Returns:

  • (String)


21792
21793
21794
21795
21796
21797
21798
21799
21800
21801
21802
21803
21804
21805
21806
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21792

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

#client_dataTypes::ClientData

The client-specific data.

Returns:



21792
21793
21794
21795
21796
21797
21798
21799
21800
21801
21802
21803
21804
21805
21806
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21792

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

#client_tokenString

The token to enable idempotency for VM import requests.

Returns:

  • (String)


21792
21793
21794
21795
21796
21797
21798
21799
21800
21801
21802
21803
21804
21805
21806
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21792

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

#descriptionString

A description string for the import image task.

Returns:

  • (String)


21792
21793
21794
21795
21796
21797
21798
21799
21800
21801
21802
21803
21804
21805
21806
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21792

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

#disk_containersArray<Types::ImageDiskContainer>

Information about the disk containers.

Returns:



21792
21793
21794
21795
21796
21797
21798
21799
21800
21801
21802
21803
21804
21805
21806
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21792

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :encrypted,
  :hypervisor,
  :kms_key_id,
  :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)


21792
21793
21794
21795
21796
21797
21798
21799
21800
21801
21802
21803
21804
21805
21806
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21792

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

#encryptedBoolean

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

Returns:

  • (Boolean)


21792
21793
21794
21795
21796
21797
21798
21799
21800
21801
21802
21803
21804
21805
21806
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21792

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

#hypervisorString

The target hypervisor platform.

Valid values: xen

Returns:

  • (String)


21792
21793
21794
21795
21796
21797
21798
21799
21800
21801
21802
21803
21804
21805
21806
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21792

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

#kms_key_idString

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

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

  • Key ID

  • Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

  • ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK 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 CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS 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 CMK must exist in the Region that the AMI is being copied to.

Returns:

  • (String)


21792
21793
21794
21795
21796
21797
21798
21799
21800
21801
21802
21803
21804
21805
21806
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21792

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :encrypted,
  :hypervisor,
  :kms_key_id,
  :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 include:

  • Auto - Detects the source-system operating system (OS) and applies the appropriate license.

  • AWS - Replaces the source-system license with an AWS license, if appropriate.

  • BYOL - Retains the source-system license, if appropriate.

Default value: Auto

Returns:

  • (String)


21792
21793
21794
21795
21796
21797
21798
21799
21800
21801
21802
21803
21804
21805
21806
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21792

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

#platformString

The operating system of the virtual machine.

Valid values: Windows | Linux

Returns:

  • (String)


21792
21793
21794
21795
21796
21797
21798
21799
21800
21801
21802
21803
21804
21805
21806
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21792

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :encrypted,
  :hypervisor,
  :kms_key_id,
  :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)


21792
21793
21794
21795
21796
21797
21798
21799
21800
21801
21802
21803
21804
21805
21806
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21792

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