Skip to content

Import Disk Image

imagebuilder_import_disk_image R Documentation

Import a Windows operating system image from a verified Microsoft ISO disk file

Description

Import a Windows operating system image from a verified Microsoft ISO disk file. The following disk images are supported:

  • Windows 11 Enterprise

Usage

imagebuilder_import_disk_image(name, semanticVersion, description,
  platform, osVersion, executionRole, infrastructureConfigurationArn, uri,
  tags, clientToken)

Arguments

name

[required] The name of the image resource that's created from the import.

semanticVersion

[required] The semantic version to attach to the image that's created during the import process. This version follows the semantic version syntax.

description

The description for your disk image import.

platform

[required] The operating system platform for the imported image. Allowed values include the following: Windows.

osVersion

[required] The operating system version for the imported image. Allowed values include the following: ⁠Microsoft Windows 11⁠.

executionRole

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions to import an image from a Microsoft ISO file.

infrastructureConfigurationArn

[required] The Amazon Resource Name (ARN) of the infrastructure configuration resource that's used for launching the EC2 instance on which the ISO image is built.

uri

[required] The uri of the ISO disk file that's stored in Amazon S3.

tags

Tags that are attached to image resources created from the import.

clientToken

[required] Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Value

A list with the following syntax: 

list(
  clientToken = "string",
  imageBuildVersionArn = "string"
)

Request syntax

svc$import_disk_image(
  name = "string",
  semanticVersion = "string",
  description = "string",
  platform = "string",
  osVersion = "string",
  executionRole = "string",
  infrastructureConfigurationArn = "string",
  uri = "string",
  tags = list(
    "string"
  ),
  clientToken = "string"
)