R: Import Image

ec2_import_image {aws.ecx}

R Documentation

Import Image

Description

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). For more information, see Importing a VM as an Image Using VM Import/Export in the VM Import/Export User Guide.

Usage

ec2_import_image(
  Architecture = NULL,
  ClientData = NULL,
  ClientToken = NULL,
  Description = NULL,
  DiskContainer = NULL,
  DryRun = NULL,
  Encrypted = NULL,
  Hypervisor = NULL,
  KmsKeyId = NULL,
  LicenseType = NULL,
  Platform = NULL,
  RoleName = NULL,
  LicenseSpecifications = NULL,
  TagSpecification = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

`Architecture`	Character. The architecture of the virtual machine. Valid values: `i386` \\| `x86_64` \\| `arm64` [optional]
`ClientData`	Object. The client-specific data.[optional]
`ClientToken`	Character. The token to enable idempotency for VM import requests.[optional]
`Description`	Character. A description string for the import image task.[optional]
`DiskContainer`	List. Information about the disk containers.[optional]
`DryRun`	Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]
`Encrypted`	Logical. Specifies whether the destination AMI of the imported image should be encrypted.[optional]
`Hypervisor`	Character. The target hypervisor platform. Valid values: `xen` [optional]
`KmsKeyId`	Character. An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK)...[optional]
`LicenseType`	Character. The license type to be used for the Amazon Machine Image (AMI) after importing.[optional]
`Platform`	Character. The operating system of the virtual machine. Valid values: `Windows` \\| `Linux` [optional]
`RoleName`	Character. The name of the role to use when not using the default role, \'vmimport\'.[optional]
`LicenseSpecifications`	List. The ARNs of the license configurations.[optional]
`TagSpecification`	List. The tags to apply to the import image task during creation.[optional]
`simplify`	Logical. Whether to simplify the result and handle `nextToken` in the response[optional]
`others`	Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]
`print_on_error`	Logical. Whether to show an error message when a network error occurs.
`retry_time`	Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent `retry_time` times but still not be able to get the response, an error will be thrown.
`network_timeout`	Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.
`region`	Character. The region of the AWS service.

Value

A list object or a character vector

Architecture

The architecture of the virtual machine.

Valid values: i386 \| x86_64 \| arm64

ClientData

The client-specific data.

ClientToken

The token to enable idempotency for VM import requests.

Description

A description string for the import image task.

DiskContainer

Information about the disk containers.

DryRun

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

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

The target hypervisor platform.

Valid values: xen

KmsKeyId

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, 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.

Amazon EBS does not support asymmetric CMKs.

LicenseType

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

The operating system of the virtual machine.

Valid values: Windows \| Linux

RoleName

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

LicenseSpecifications

The ARNs of the license configurations.

TagSpecification

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

[Package aws.ecx version 1.0.5 Index]