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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#architectureString

The architecture of the virtual machine.

Valid values: i386 | x86_64

Returns:

  • (String)


43628
43629
43630
43631
43632
43633
43634
43635
43636
43637
43638
43639
43640
43641
43642
43643
43644
43645
43646
43647
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43628

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_modeString

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.

Returns:

  • (String)


43628
43629
43630
43631
43632
43633
43634
43635
43636
43637
43638
43639
43640
43641
43642
43643
43644
43645
43646
43647
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43628

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_dataTypes::ClientData

The client-specific data.

Returns:



43628
43629
43630
43631
43632
43633
43634
43635
43636
43637
43638
43639
43640
43641
43642
43643
43644
43645
43646
43647
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43628

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_tokenString

The token to enable idempotency for VM import requests.

Returns:

  • (String)


43628
43629
43630
43631
43632
43633
43634
43635
43636
43637
43638
43639
43640
43641
43642
43643
43644
43645
43646
43647
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43628

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

#descriptionString

A description string for the import image task.

Returns:

  • (String)


43628
43629
43630
43631
43632
43633
43634
43635
43636
43637
43638
43639
43640
43641
43642
43643
43644
43645
43646
43647
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43628

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_containersArray<Types::ImageDiskContainer>

Information about the disk containers.

Returns:



43628
43629
43630
43631
43632
43633
43634
43635
43636
43637
43638
43639
43640
43641
43642
43643
43644
43645
43646
43647
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43628

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


43628
43629
43630
43631
43632
43633
43634
43635
43636
43637
43638
43639
43640
43641
43642
43643
43644
43645
43646
43647
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43628

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

#encryptedBoolean

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)


43628
43629
43630
43631
43632
43633
43634
43635
43636
43637
43638
43639
43640
43641
43642
43643
43644
43645
43646
43647
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43628

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

#hypervisorString

The target hypervisor platform.

Valid values: xen

Returns:

  • (String)


43628
43629
43630
43631
43632
43633
43634
43635
43636
43637
43638
43639
43640
43641
43642
43643
43644
43645
43646
43647
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43628

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_idString

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.

Returns:

  • (String)


43628
43629
43630
43631
43632
43633
43634
43635
43636
43637
43638
43639
43640
43641
43642
43643
43644
43645
43646
43647
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43628

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_specificationsArray<Types::ImportImageLicenseConfigurationRequest>

The ARNs of the license configurations.



43628
43629
43630
43631
43632
43633
43634
43635
43636
43637
43638
43639
43640
43641
43642
43643
43644
43645
43646
43647
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43628

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_typeString

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.

Returns:

  • (String)


43628
43629
43630
43631
43632
43633
43634
43635
43636
43637
43638
43639
43640
43641
43642
43643
43644
43645
43646
43647
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43628

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

#platformString

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

Returns:

  • (String)


43628
43629
43630
43631
43632
43633
43634
43635
43636
43637
43638
43639
43640
43641
43642
43643
43644
43645
43646
43647
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43628

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_nameString

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

Returns:

  • (String)


43628
43629
43630
43631
43632
43633
43634
43635
43636
43637
43638
43639
43640
43641
43642
43643
43644
43645
43646
43647
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43628

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_specificationsArray<Types::TagSpecification>

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

Returns:



43628
43629
43630
43631
43632
43633
43634
43635
43636
43637
43638
43639
43640
43641
43642
43643
43644
43645
43646
43647
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43628

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_operationString

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

Returns:

  • (String)


43628
43629
43630
43631
43632
43633
43634
43635
43636
43637
43638
43639
43640
43641
43642
43643
43644
43645
43646
43647
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43628

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