Package software.amazon.awssdk.services.appstream.model

Class ImageBuilder

java.lang.Object

software.amazon.awssdk.services.appstream.model.ImageBuilder

All Implemented Interfaces:

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

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

Describes a virtual machine that is used to create an image.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ImageBuilder.Builder

Method Summary

Modifier and Type	Method	Description
List<AccessEndpoint>	accessEndpoints()	The list of virtual private cloud (VPC) interface endpoint objects.
String	appstreamAgentVersion()	The version of the AppStream 2.0 agent that is currently being used by the image builder.
String	arn()	The ARN for the image builder.
static ImageBuilder.Builder	builder()
Instant	createdTime()	The time stamp when the image builder was created.
String	description()	The description to display.
String	displayName()	The image builder name to display.
DomainJoinInfo	domainJoinInfo()	The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
Boolean	enableDefaultInternetAccess()	Enables or disables default internet access for the image builder.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAccessEndpoints()	For responses, this returns true if the service returned a value for the AccessEndpoints property.
int	hashCode()
boolean	hasImageBuilderErrors()	For responses, this returns true if the service returned a value for the ImageBuilderErrors property.
String	iamRoleArn()	The ARN of the IAM role that is applied to the image builder.
String	imageArn()	The ARN of the image from which this builder was created.
List<ResourceError>	imageBuilderErrors()	The image builder errors.
String	instanceType()	The instance type for the image builder.
LatestAppstreamAgentVersion	latestAppstreamAgentVersion()	Indicates whether the image builder is using the latest AppStream 2.0 agent version or not.
String	latestAppstreamAgentVersionAsString()	Indicates whether the image builder is using the latest AppStream 2.0 agent version or not.
String	name()	The name of the image builder.
NetworkAccessConfiguration	networkAccessConfiguration()	Returns the value of the NetworkAccessConfiguration property for this object.
PlatformType	platform()	The operating system platform of the image builder.
String	platformAsString()	The operating system platform of the image builder.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ImageBuilder.Builder>	serializableBuilderClass()
ImageBuilderState	state()	The state of the image builder.
String	stateAsString()	The state of the image builder.
ImageBuilderStateChangeReason	stateChangeReason()	The reason why the last state change occurred.
ImageBuilder.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
VpcConfig	vpcConfig()	The VPC configuration of the image builder.

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

name

public final String name()

The name of the image builder.

Returns:

The name of the image builder.

arn

public final String arn()

The ARN for the image builder.

Returns:

The ARN for the image builder.

imageArn

public final String imageArn()

The ARN of the image from which this builder was created.

Returns:

The ARN of the image from which this builder was created.

description

public final String description()

The description to display.

Returns:

The description to display.

displayName

public final String displayName()

The image builder name to display.

Returns:

The image builder name to display.

vpcConfig

public final VpcConfig vpcConfig()

The VPC configuration of the image builder.

Returns:

The VPC configuration of the image builder.

instanceType

public final String instanceType()

The instance type for the image builder. The following instance types are available:

• stream.standard.small

• stream.standard.medium

• stream.standard.large

• stream.compute.large

• stream.compute.xlarge

• stream.compute.2xlarge

• stream.compute.4xlarge

• stream.compute.8xlarge

• stream.memory.large

• stream.memory.xlarge

• stream.memory.2xlarge

• stream.memory.4xlarge

• stream.memory.8xlarge

• stream.memory.z1d.large

• stream.memory.z1d.xlarge

• stream.memory.z1d.2xlarge

• stream.memory.z1d.3xlarge

• stream.memory.z1d.6xlarge

• stream.memory.z1d.12xlarge

• stream.graphics-design.large

• stream.graphics-design.xlarge

• stream.graphics-design.2xlarge

• stream.graphics-design.4xlarge

• stream.graphics-desktop.2xlarge

• stream.graphics.g4dn.xlarge

• stream.graphics.g4dn.2xlarge

• stream.graphics.g4dn.4xlarge

• stream.graphics.g4dn.8xlarge

• stream.graphics.g4dn.12xlarge

• stream.graphics.g4dn.16xlarge

• stream.graphics-pro.4xlarge

• stream.graphics-pro.8xlarge

• stream.graphics-pro.16xlarge

Returns:

The instance type for the image builder. The following instance types are available:

• stream.standard.small

• stream.standard.medium

• stream.standard.large

• stream.compute.large

• stream.compute.xlarge

• stream.compute.2xlarge

• stream.compute.4xlarge

• stream.compute.8xlarge

• stream.memory.large

• stream.memory.xlarge

• stream.memory.2xlarge

• stream.memory.4xlarge

• stream.memory.8xlarge

• stream.memory.z1d.large

• stream.memory.z1d.xlarge

• stream.memory.z1d.2xlarge

• stream.memory.z1d.3xlarge

• stream.memory.z1d.6xlarge

• stream.memory.z1d.12xlarge

• stream.graphics-design.large

• stream.graphics-design.xlarge

• stream.graphics-design.2xlarge

• stream.graphics-design.4xlarge

• stream.graphics-desktop.2xlarge

• stream.graphics.g4dn.xlarge

• stream.graphics.g4dn.2xlarge

• stream.graphics.g4dn.4xlarge

• stream.graphics.g4dn.8xlarge

• stream.graphics.g4dn.12xlarge

• stream.graphics.g4dn.16xlarge

• stream.graphics-pro.4xlarge

• stream.graphics-pro.8xlarge

• stream.graphics-pro.16xlarge

platform

public final PlatformType platform()

The operating system platform of the image builder.

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

Returns:

The operating system platform of the image builder.

See Also:

PlatformType

platformAsString

public final String platformAsString()

The operating system platform of the image builder.

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

Returns:

The operating system platform of the image builder.

See Also:

PlatformType

iamRoleArn

public final String iamRoleArn()

The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

Returns:

The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

state

public final ImageBuilderState state()

The state of the image builder.

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

Returns:

The state of the image builder.

See Also:

ImageBuilderState

stateAsString

public final String stateAsString()

The state of the image builder.

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

Returns:

The state of the image builder.

See Also:

ImageBuilderState

stateChangeReason

public final ImageBuilderStateChangeReason stateChangeReason()

The reason why the last state change occurred.

Returns:

The reason why the last state change occurred.

createdTime

public final Instant createdTime()

The time stamp when the image builder was created.

Returns:

The time stamp when the image builder was created.

enableDefaultInternetAccess

public final Boolean enableDefaultInternetAccess()

Enables or disables default internet access for the image builder.

Returns:

Enables or disables default internet access for the image builder.

domainJoinInfo

public final DomainJoinInfo domainJoinInfo()

The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

Returns:

The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

networkAccessConfiguration

public final NetworkAccessConfiguration networkAccessConfiguration()

Returns the value of the NetworkAccessConfiguration property for this object.

Returns:

The value of the NetworkAccessConfiguration property for this object.

hasImageBuilderErrors

public final boolean hasImageBuilderErrors()

For responses, this returns true if the service returned a value for the ImageBuilderErrors 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.

imageBuilderErrors

public final List<ResourceError> imageBuilderErrors()

The image builder errors.

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 hasImageBuilderErrors() method.

Returns:

The image builder errors.

appstreamAgentVersion

public final String appstreamAgentVersion()

The version of the AppStream 2.0 agent that is currently being used by the image builder.

Returns:

The version of the AppStream 2.0 agent that is currently being used by the image builder.

hasAccessEndpoints

public final boolean hasAccessEndpoints()

For responses, this returns true if the service returned a value for the AccessEndpoints 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.

accessEndpoints

public final List<AccessEndpoint> accessEndpoints()

The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.

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 hasAccessEndpoints() method.

Returns:

The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.

latestAppstreamAgentVersion

public final LatestAppstreamAgentVersion latestAppstreamAgentVersion()

Indicates whether the image builder is using the latest AppStream 2.0 agent version or not.

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

Returns:

Indicates whether the image builder is using the latest AppStream 2.0 agent version or not.

See Also:

LatestAppstreamAgentVersion

latestAppstreamAgentVersionAsString

public final String latestAppstreamAgentVersionAsString()

Indicates whether the image builder is using the latest AppStream 2.0 agent version or not.

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

Returns:

Indicates whether the image builder is using the latest AppStream 2.0 agent version or not.

See Also:

LatestAppstreamAgentVersion

toBuilder

public ImageBuilder.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ImageBuilder.Builder,ImageBuilder>

builder

public static ImageBuilder.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo