Skip to content

S3ExportConfiguration

Source code in docs_src/capo_imagebuilder/types/s3_export_configuration.py 
14
15
16
17
18
19
20
21
22
class S3ExportConfiguration(TypedDict, closed=True):
    role_name: "capo_imagebuilder.types.non_empty_string.NonEmptyString"
    """<p>The name of the role that grants VM Import/Export permission to export images to your S3 bucket.</p>"""
    disk_image_format: "capo_imagebuilder.types.disk_image_format.DiskImageFormat"
    """<p>Export the updated image to one of the following supported disk image formats:</p> <ul> <li> <p> <b>Virtual Hard Disk (VHD)</b> – Compatible with Citrix Xen and Microsoft Hyper-V virtualization products.</p> </li> <li> <p> <b>Stream-optimized ESX Virtual Machine Disk (VMDK)</b> – Compatible with VMware ESX and VMware vSphere versions 4, 5, and 6.</p> </li> <li> <p> <b>Raw</b> – Raw format.</p> </li> </ul>"""
    s3_bucket: "capo_imagebuilder.types.non_empty_string.NonEmptyString"
    """<p>The S3 bucket in which to store the output disk images for your VM.</p>"""
    s3_prefix: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>The Amazon S3 path for the bucket where the output disk images for your VM are stored.</p>"""

disk_image_format instance-attribute 

disk_image_format: DiskImageFormat

Export the updated image to one of the following supported disk image formats:

  • Virtual Hard Disk (VHD) – Compatible with Citrix Xen and Microsoft Hyper-V virtualization products.

  • Stream-optimized ESX Virtual Machine Disk (VMDK) – Compatible with VMware ESX and VMware vSphere versions 4, 5, and 6.

  • Raw – Raw format.

role_name instance-attribute 

role_name: NonEmptyString

The name of the role that grants VM Import/Export permission to export images to your S3 bucket.

s3_bucket instance-attribute 

s3_bucket: NonEmptyString

The S3 bucket in which to store the output disk images for your VM.

s3_prefix instance-attribute 

s3_prefix: NotRequired[NonEmptyString]

The Amazon S3 path for the bucket where the output disk images for your VM are stored.