Package software.amazon.awssdk.services.imagebuilder.model

Class S3ExportConfiguration

java.lang.Object

software.amazon.awssdk.services.imagebuilder.model.S3ExportConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<S3ExportConfiguration.Builder,S3ExportConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class S3ExportConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<S3ExportConfiguration.Builder,S3ExportConfiguration>

Properties that configure export from your build instance to a compatible file format for your VM.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	S3ExportConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static S3ExportConfiguration.Builder	builder()
DiskImageFormat	diskImageFormat()	Export the updated image to one of the following supported disk image formats:
String	diskImageFormatAsString()	Export the updated image to one of the following supported disk image formats:
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	roleName()	The name of the role that grants VM Import/Export permission to export images to your S3 bucket.
String	s3Bucket()	The S3 bucket in which to store the output disk images for your VM.
String	s3Prefix()	The Amazon S3 path for the bucket where the output disk images for your VM are stored.
List<SdkField<?>>	sdkFields()
static Class<? extends S3ExportConfiguration.Builder>	serializableBuilderClass()
S3ExportConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

roleName

public final String roleName()

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

Returns:

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

diskImageFormat

public final DiskImageFormat 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.

If the service returns an enum value that is not available in the current SDK version, diskImageFormat will return DiskImageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from diskImageFormatAsString().

Returns:

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.

See Also:

DiskImageFormat

diskImageFormatAsString

public final String diskImageFormatAsString()

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.

If the service returns an enum value that is not available in the current SDK version, diskImageFormat will return DiskImageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from diskImageFormatAsString().

Returns:

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.

See Also:

DiskImageFormat

s3Bucket

public final String s3Bucket()

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

Returns:

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

s3Prefix

public final String s3Prefix()

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

Returns:

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

toBuilder

public S3ExportConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<S3ExportConfiguration.Builder,S3ExportConfiguration>

builder

public static S3ExportConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends S3ExportConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo