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
- Struct
- Aws::EC2::Types::ImportImageRequest
- Defined in:
- (unknown)
Overview
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: "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: "client-vpn-endpoint", # accepts client-vpn-endpoint, customer-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, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
tags: [
{
key: "String",
value: "String",
},
],
},
],
}
Instance Attribute Summary collapse
-
#architecture ⇒ String
The architecture 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 AWS Key Management Service (AWS KMS) customer master key (CMK) 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 image being imported.
Instance Attribute Details
#architecture ⇒ String
The architecture of the virtual machine.
Valid values: i386
| x86_64
| arm64
#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. If you have
the required permissions, the error response is DryRunOperation
.
Otherwise, it is UnauthorizedOperation
.
#encrypted ⇒ Boolean
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.
#hypervisor ⇒ String
The target hypervisor platform.
Valid values: xen
#kms_key_id ⇒ String
An identifier for the symmetric 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, thealias
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, thekey
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, thealias
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.
Amazon EBS does not support asymmetric CMKs.
#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.
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 AWS 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 AWS. For more information, see
Prerequisites in the VM Import/Export User Guide.
#platform ⇒ String
The operating system of the virtual machine.
Valid values: Windows
| Linux
#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 image being imported.