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

Class InstanceConfiguration

java.lang.Object

software.amazon.awssdk.services.imagebuilder.model.InstanceConfiguration

All Implemented Interfaces:

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

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

Defines a custom base AMI and block device mapping configurations of an instance used for building and testing container images.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InstanceConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
List<InstanceBlockDeviceMapping>	blockDeviceMappings()	Defines the block devices to attach for building an instance from this Image Builder AMI.
static InstanceConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBlockDeviceMappings()	For responses, this returns true if the service returned a value for the BlockDeviceMappings property.
int	hashCode()
String	image()	The AMI ID to use as the base image for a container build and test instance.
List<SdkField<?>>	sdkFields()
static Class<? extends InstanceConfiguration.Builder>	serializableBuilderClass()
InstanceConfiguration.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

image

public final String image()

The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

Returns:

The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

hasBlockDeviceMappings

public final boolean hasBlockDeviceMappings()

For responses, this returns true if the service returned a value for the BlockDeviceMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

blockDeviceMappings

public final List<InstanceBlockDeviceMapping> blockDeviceMappings()

Defines the block devices to attach for building an instance from this Image Builder AMI.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBlockDeviceMappings() method.

Returns:

Defines the block devices to attach for building an instance from this Image Builder AMI.

toBuilder

public InstanceConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InstanceConfiguration.Builder,InstanceConfiguration>

builder

public static InstanceConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends InstanceConfiguration.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