ImportDiskImageRequest
¶
Source code in docs_src/capo_imagebuilder/types/import_disk_image_request.py
client_token
instance-attribute
¶
client_token: ClientToken
A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
description
instance-attribute
¶
description: NotRequired[NonEmptyString]
The description for your disk image import.
execution_role
instance-attribute
¶
execution_role: NotRequired[RoleNameOrArn]
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. If you don't provide a role, Image Builder uses the Image Builder service-linked role in your account, and creates it if it doesn't exist.
infrastructure_configuration_arn
instance-attribute
¶
infrastructure_configuration_arn: InfrastructureConfigurationArn
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.
logging_configuration
instance-attribute
¶
logging_configuration: NotRequired[ImageLoggingConfiguration]
The CloudWatch Logs log group where Image Builder sends the import logs. If you specify a log group name outside of the /aws/imagebuilder/ namespace, you must also provide an executionRole that has permission to write to that log group.
name
instance-attribute
¶
name: ResourceName
The name of the image resource that's created from the import. Image Builder generates the image ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name. If an image with the same name and semantic version already exists in your account in the same Amazon Web Services Region, the import creates a new build version for it.
os_version
instance-attribute
¶
os_version: OsVersion
The operating system version for the imported image. The only supported value is Microsoft Windows 11.
platform
instance-attribute
¶
platform: NonEmptyString
The operating system platform for the imported image. Allowed values include the following: Windows.
register_image_options
instance-attribute
¶
register_image_options: NotRequired[RegisterImageOptions]
Configures Secure Boot and UEFI settings for the imported image.
semantic_version
instance-attribute
¶
semantic_version: VersionNumber
The semantic version to attach to the image that's created during the import process. This version follows the semantic version syntax.
tags
instance-attribute
¶
tags: NotRequired[TagMap]
Tags that are attached to image resources created from the import.
uri
instance-attribute
¶
uri: Uri
The uri of the ISO disk file that's stored in Amazon S3, in s3://bucket/key format. The key must end with the .iso, .ISO, or .Iso extension, and the bucket must be owned by the account that makes the request.
windows_configuration
instance-attribute
¶
windows_configuration: NotRequired[WindowsConfiguration]
Specifies Windows settings for ISO imports.