| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.ImageBuilder.ImportVmImage
Description
When you export your virtual machine (VM) from its virtualization environment, that process creates a set of one or more disk container files that act as snapshots of your VM’s environment, settings, and data. The Amazon EC2 API ImportImage action uses those files to import your VM and create an AMI. To import using the CLI command, see import-image
You can reference the task ID from the VM import to pull in the AMI that the import created as the base image for your Image Builder recipe.
Synopsis
- data ImportVmImage = ImportVmImage' {}
- newImportVmImage :: Text -> Text -> Platform -> Text -> Text -> ImportVmImage
- importVmImage_description :: Lens' ImportVmImage (Maybe Text)
- importVmImage_osVersion :: Lens' ImportVmImage (Maybe Text)
- importVmImage_tags :: Lens' ImportVmImage (Maybe (HashMap Text Text))
- importVmImage_name :: Lens' ImportVmImage Text
- importVmImage_semanticVersion :: Lens' ImportVmImage Text
- importVmImage_platform :: Lens' ImportVmImage Platform
- importVmImage_vmImportTaskId :: Lens' ImportVmImage Text
- importVmImage_clientToken :: Lens' ImportVmImage Text
- data ImportVmImageResponse = ImportVmImageResponse' {}
- newImportVmImageResponse :: Int -> ImportVmImageResponse
- importVmImageResponse_clientToken :: Lens' ImportVmImageResponse (Maybe Text)
- importVmImageResponse_imageArn :: Lens' ImportVmImageResponse (Maybe Text)
- importVmImageResponse_requestId :: Lens' ImportVmImageResponse (Maybe Text)
- importVmImageResponse_httpStatus :: Lens' ImportVmImageResponse Int
Creating a Request
data ImportVmImage Source #
See: newImportVmImage smart constructor.
Constructors
| ImportVmImage' | |
Fields
| |
Instances
Create a value of ImportVmImage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ImportVmImage, importVmImage_description - The description for the base image that is created by the import
process.
ImportVmImage, importVmImage_osVersion - The operating system version for the imported VM.
ImportVmImage, importVmImage_tags - Tags that are attached to the import resources.
ImportVmImage, importVmImage_name - The name of the base image that is created by the import process.
$sel:semanticVersion:ImportVmImage', importVmImage_semanticVersion - The semantic version to attach to the base image that was created during
the import process. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
ImportVmImage, importVmImage_platform - The operating system platform for the imported VM.
$sel:vmImportTaskId:ImportVmImage', importVmImage_vmImportTaskId - The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM
import process. Image Builder retrieves information from the import
process to pull in the AMI that is created from the VM source as the
base image for your recipe.
ImportVmImage, importVmImage_clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see
Ensuring idempotency
in the Amazon EC2 API Reference.
Request Lenses
importVmImage_description :: Lens' ImportVmImage (Maybe Text) Source #
The description for the base image that is created by the import process.
importVmImage_osVersion :: Lens' ImportVmImage (Maybe Text) Source #
The operating system version for the imported VM.
importVmImage_tags :: Lens' ImportVmImage (Maybe (HashMap Text Text)) Source #
Tags that are attached to the import resources.
importVmImage_name :: Lens' ImportVmImage Text Source #
The name of the base image that is created by the import process.
importVmImage_semanticVersion :: Lens' ImportVmImage Text Source #
The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
importVmImage_platform :: Lens' ImportVmImage Platform Source #
The operating system platform for the imported VM.
importVmImage_vmImportTaskId :: Lens' ImportVmImage Text Source #
The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM
import process. Image Builder retrieves information from the import
process to pull in the AMI that is created from the VM source as the
base image for your recipe.
importVmImage_clientToken :: Lens' ImportVmImage Text Source #
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
Destructuring the Response
data ImportVmImageResponse Source #
See: newImportVmImageResponse smart constructor.
Constructors
| ImportVmImageResponse' | |
Fields
| |
Instances
newImportVmImageResponse Source #
Create a value of ImportVmImageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ImportVmImage, importVmImageResponse_clientToken - The idempotency token that was used for this request.
$sel:imageArn:ImportVmImageResponse', importVmImageResponse_imageArn - The Amazon Resource Name (ARN) of the AMI that was created during the VM
import process. This AMI is used as the base image for the recipe that
imported the VM.
$sel:requestId:ImportVmImageResponse', importVmImageResponse_requestId - The request ID that uniquely identifies this request.
$sel:httpStatus:ImportVmImageResponse', importVmImageResponse_httpStatus - The response's http status code.
Response Lenses
importVmImageResponse_clientToken :: Lens' ImportVmImageResponse (Maybe Text) Source #
The idempotency token that was used for this request.
importVmImageResponse_imageArn :: Lens' ImportVmImageResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the AMI that was created during the VM import process. This AMI is used as the base image for the recipe that imported the VM.
importVmImageResponse_requestId :: Lens' ImportVmImageResponse (Maybe Text) Source #
The request ID that uniquely identifies this request.
importVmImageResponse_httpStatus :: Lens' ImportVmImageResponse Int Source #
The response's http status code.