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

Inherits:

Struct

Object
Struct
Aws::EC2::Types::ImportImageRequest

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: "SnapshotId",
      url: "String",
      user_bucket: {
        s3_bucket: "String",
        s3_key: "String",
      },
    },
  ],
  dry_run: false,
  encrypted: false,
  hypervisor: "String",
  kms_key_id: "KmsKeyId",
  license_type: "String",
  platform: "String",
  role_name: "String",
  license_specifications: [
    {
      license_configuration_arn: "String",
    },
  ],
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts capacity-reservation, client-vpn-endpoint, customer-gateway, carrier-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, instance-event-window, internet-gateway, ipv4pool-ec2, ipv6pool-ec2, key-pair, launch-template, local-gateway, local-gateway-route-table, local-gateway-virtual-interface, local-gateway-virtual-interface-group, local-gateway-route-table-vpc-association, local-gateway-route-table-virtual-interface-group-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, placement-group, prefix-list, replace-root-volume-task, reserved-instances, route-table, security-group, security-group-rule, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-endpoint, vpc-endpoint-service, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  usage_operation: "String",
  boot_mode: "legacy-bios", # accepts legacy-bios, uefi
}

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#architecture ⇒ String
The architecture of the virtual machine.
#boot_mode ⇒ String
The boot mode of the virtual machine.
#client_data ⇒ Types::ClientData
The client-specific data.
#client_token ⇒ String
The token to enable idempotency for VM import requests.
#description ⇒ String
A description string for the import image task.
#disk_containers ⇒ Array<Types::ImageDiskContainer>
Information about the disk containers.
#dry_run ⇒ Boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
#encrypted ⇒ Boolean
Specifies whether the destination AMI of the imported image should be encrypted.
#hypervisor ⇒ String
The target hypervisor platform.
#kms_key_id ⇒ String
An identifier for the symmetric KMS key to use when creating the encrypted AMI.
#license_specifications ⇒ Array<Types::ImportImageLicenseConfigurationRequest>
The ARNs of the license configurations.
#license_type ⇒ String
The license type to be used for the Amazon Machine Image (AMI) after importing.
#platform ⇒ String
The operating system of the virtual machine.
#role_name ⇒ String
The name of the role to use when not using the default role, 'vmimport'.
#tag_specifications ⇒ Array<Types::TagSpecification>
The tags to apply to the import image task during creation.
#usage_operation ⇒ String
The usage operation value.

Instance Attribute Details

#architecture ⇒ `String`

The architecture of the virtual machine.

Valid values: i386 | x86_64 | arm64

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 33691

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :encrypted,
  :hypervisor,
  :kms_key_id,
  :license_type,
  :platform,
  :role_name,
  :license_specifications,
  :tag_specifications,
  :usage_operation,
  :boot_mode)
  SENSITIVE = []
  include Aws::Structure
end

#boot_mode ⇒ `String`

The boot mode of the virtual machine.

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 33691

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :encrypted,
  :hypervisor,
  :kms_key_id,
  :license_type,
  :platform,
  :role_name,
  :license_specifications,
  :tag_specifications,
  :usage_operation,
  :boot_mode)
  SENSITIVE = []
  include Aws::Structure
end

#client_data ⇒ `Types::ClientData`

The client-specific data.

Returns:

(Types::ClientData)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 33691

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :encrypted,
  :hypervisor,
  :kms_key_id,
  :license_type,
  :platform,
  :role_name,
  :license_specifications,
  :tag_specifications,
  :usage_operation,
  :boot_mode)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ `String`

The token to enable idempotency for VM import requests.

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 33691

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :encrypted,
  :hypervisor,
  :kms_key_id,
  :license_type,
  :platform,
  :role_name,
  :license_specifications,
  :tag_specifications,
  :usage_operation,
  :boot_mode)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A description string for the import image task.

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 33691

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :encrypted,
  :hypervisor,
  :kms_key_id,
  :license_type,
  :platform,
  :role_name,
  :license_specifications,
  :tag_specifications,
  :usage_operation,
  :boot_mode)
  SENSITIVE = []
  include Aws::Structure
end

#disk_containers ⇒ `Array<Types::ImageDiskContainer>`

Information about the disk containers.

Returns:

(Array<Types::ImageDiskContainer>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 33691

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :encrypted,
  :hypervisor,
  :kms_key_id,
  :license_type,
  :platform,
  :role_name,
  :license_specifications,
  :tag_specifications,
  :usage_operation,
  :boot_mode)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ `Boolean`

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)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 33691

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :encrypted,
  :hypervisor,
  :kms_key_id,
  :license_type,
  :platform,
  :role_name,
  :license_specifications,
  :tag_specifications,
  :usage_operation,
  :boot_mode)
  SENSITIVE = []
  include Aws::Structure
end

#encrypted ⇒ `Boolean`

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.

Returns:

(Boolean)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 33691

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :encrypted,
  :hypervisor,
  :kms_key_id,
  :license_type,
  :platform,
  :role_name,
  :license_specifications,
  :tag_specifications,
  :usage_operation,
  :boot_mode)
  SENSITIVE = []
  include Aws::Structure
end

#hypervisor ⇒ `String`

The target hypervisor platform.

Valid values: xen

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 33691

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :encrypted,
  :hypervisor,
  :kms_key_id,
  :license_type,
  :platform,
  :role_name,
  :license_specifications,
  :tag_specifications,
  :usage_operation,
  :boot_mode)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ `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. 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.
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.

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 33691

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :encrypted,
  :hypervisor,
  :kms_key_id,
  :license_type,
  :platform,
  :role_name,
  :license_specifications,
  :tag_specifications,
  :usage_operation,
  :boot_mode)
  SENSITIVE = []
  include Aws::Structure
end

#license_specifications ⇒ `Array<Types::ImportImageLicenseConfigurationRequest>`

The ARNs of the license configurations.

Returns:

(Array<Types::ImportImageLicenseConfigurationRequest>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 33691

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :encrypted,
  :hypervisor,
  :kms_key_id,
  :license_type,
  :platform,
  :role_name,
  :license_specifications,
  :tag_specifications,
  :usage_operation,
  :boot_mode)
  SENSITIVE = []
  include Aws::Structure
end

#license_type ⇒ `String`

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

By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify AWS to replace the source-system license with an Amazon Web Services license, if appropriate. Specify BYOL to retain the source-system license, if appropriate.

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.

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 33691

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :encrypted,
  :hypervisor,
  :kms_key_id,
  :license_type,
  :platform,
  :role_name,
  :license_specifications,
  :tag_specifications,
  :usage_operation,
  :boot_mode)
  SENSITIVE = []
  include Aws::Structure
end

#platform ⇒ `String`

The operating system of the virtual machine.

Valid values: Windows | Linux

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 33691

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :encrypted,
  :hypervisor,
  :kms_key_id,
  :license_type,
  :platform,
  :role_name,
  :license_specifications,
  :tag_specifications,
  :usage_operation,
  :boot_mode)
  SENSITIVE = []
  include Aws::Structure
end

#role_name ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 33691

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :encrypted,
  :hypervisor,
  :kms_key_id,
  :license_type,
  :platform,
  :role_name,
  :license_specifications,
  :tag_specifications,
  :usage_operation,
  :boot_mode)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ `Array<Types::TagSpecification>`

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

Returns:

(Array<Types::TagSpecification>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 33691

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :encrypted,
  :hypervisor,
  :kms_key_id,
  :license_type,
  :platform,
  :role_name,
  :license_specifications,
  :tag_specifications,
  :usage_operation,
  :boot_mode)
  SENSITIVE = []
  include Aws::Structure
end

#usage_operation ⇒ `String`

The usage operation value. For more information, see AMI billing information fields in the Amazon Elastic Compute Cloud User Guide.

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 33691

class ImportImageRequest < Struct.new(
  :architecture,
  :client_data,
  :client_token,
  :description,
  :disk_containers,
  :dry_run,
  :encrypted,
  :hypervisor,
  :kms_key_id,
  :license_type,
  :platform,
  :role_name,
  :license_specifications,
  :tag_specifications,
  :usage_operation,
  :boot_mode)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#architecture ⇒ String

#boot_mode ⇒ String

#client_data ⇒ Types::ClientData

#client_token ⇒ String

#description ⇒ String

#disk_containers ⇒ Array<Types::ImageDiskContainer>

#dry_run ⇒ Boolean

#encrypted ⇒ Boolean

#hypervisor ⇒ String

#kms_key_id ⇒ String

#license_specifications ⇒ Array<Types::ImportImageLicenseConfigurationRequest>

#license_type ⇒ String

#platform ⇒ String

#role_name ⇒ String

#tag_specifications ⇒ Array<Types::TagSpecification>

#usage_operation ⇒ String

#architecture ⇒ `String`

#boot_mode ⇒ `String`

#client_data ⇒ `Types::ClientData`

#client_token ⇒ `String`

#description ⇒ `String`

#disk_containers ⇒ `Array<Types::ImageDiskContainer>`

#dry_run ⇒ `Boolean`

#encrypted ⇒ `Boolean`

#hypervisor ⇒ `String`

#kms_key_id ⇒ `String`

#license_specifications ⇒ `Array<Types::ImportImageLicenseConfigurationRequest>`

#license_type ⇒ `String`

#platform ⇒ `String`

#role_name ⇒ `String`

#tag_specifications ⇒ `Array<Types::TagSpecification>`

#usage_operation ⇒ `String`