software.amazon.awssdk.services.appstream.model

Interface Image.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Image.Builder,Image>, SdkBuilder<Image.Builder,Image>, SdkPojo

Enclosing class:

Image

public static interface Image.Builder
extends SdkPojo, CopyableBuilder<Image.Builder,Image>

Method Summary

Modifier and Type	Method and Description
Image.Builder	applications(Application... applications) The applications associated with the image.
Image.Builder	applications(Collection<Application> applications) The applications associated with the image.
Image.Builder	applications(Consumer<Application.Builder>... applications) The applications associated with the image.
Image.Builder	appstreamAgentVersion(String appstreamAgentVersion) The version of the AppStream 2.0 agent to use for instances that are launched from this image.
Image.Builder	arn(String arn) The ARN of the image.
Image.Builder	baseImageArn(String baseImageArn) The ARN of the image from which this image was created.
Image.Builder	createdTime(Instant createdTime) The time the image was created.
Image.Builder	description(String description) The description to display.
Image.Builder	displayName(String displayName) The image name to display.
Image.Builder	imageBuilderName(String imageBuilderName) The name of the image builder that was used to create the private image.
Image.Builder	imageBuilderSupported(Boolean imageBuilderSupported) Indicates whether an image builder can be launched from this image.
Image.Builder	imageErrors(Collection<ResourceError> imageErrors) Describes the errors that are returned when a new image can't be created.
Image.Builder	imageErrors(Consumer<ResourceError.Builder>... imageErrors) Describes the errors that are returned when a new image can't be created.
Image.Builder	imageErrors(ResourceError... imageErrors) Describes the errors that are returned when a new image can't be created.
default Image.Builder	imagePermissions(Consumer<ImagePermissions.Builder> imagePermissions) The permissions to provide to the destination AWS account for the specified image.
Image.Builder	imagePermissions(ImagePermissions imagePermissions) The permissions to provide to the destination AWS account for the specified image.
Image.Builder	name(String name) The name of the image.
Image.Builder	platform(PlatformType platform) The operating system platform of the image.
Image.Builder	platform(String platform) The operating system platform of the image.
Image.Builder	publicBaseImageReleasedDate(Instant publicBaseImageReleasedDate) The release date of the public base image.
Image.Builder	state(ImageState state) The image starts in the PENDING state.
Image.Builder	state(String state) The image starts in the PENDING state.
default Image.Builder	stateChangeReason(Consumer<ImageStateChangeReason.Builder> stateChangeReason) The reason why the last state change occurred.
Image.Builder	stateChangeReason(ImageStateChangeReason stateChangeReason) The reason why the last state change occurred.
Image.Builder	visibility(String visibility) Indicates whether the image is public or private.
Image.Builder	visibility(VisibilityType visibility) Indicates whether the image is public or private.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

name

Image.Builder name(String name)

The name of the image.

Parameters:

name - The name of the image.

Returns:

Returns a reference to this object so that method calls can be chained together.

arn

Image.Builder arn(String arn)

The ARN of the image.

Parameters:

arn - The ARN of the image.

Returns:

Returns a reference to this object so that method calls can be chained together.

baseImageArn

Image.Builder baseImageArn(String baseImageArn)

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

Parameters:

baseImageArn - The ARN of the image from which this image was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

displayName

Image.Builder displayName(String displayName)

The image name to display.

Parameters:

displayName - The image name to display.

Returns:

Returns a reference to this object so that method calls can be chained together.

state

Image.Builder state(String state)

The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.

Parameters:

state - The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ImageState, ImageState

state

Image.Builder state(ImageState state)

The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.

Parameters:

state - The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ImageState, ImageState

visibility

Image.Builder visibility(String visibility)

Indicates whether the image is public or private.

Parameters:

visibility - Indicates whether the image is public or private.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VisibilityType, VisibilityType

visibility

Image.Builder visibility(VisibilityType visibility)

Indicates whether the image is public or private.

Parameters:

visibility - Indicates whether the image is public or private.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VisibilityType, VisibilityType

imageBuilderSupported

Image.Builder imageBuilderSupported(Boolean imageBuilderSupported)

Indicates whether an image builder can be launched from this image.

Parameters:

imageBuilderSupported - Indicates whether an image builder can be launched from this image.

Returns:

Returns a reference to this object so that method calls can be chained together.

imageBuilderName

Image.Builder imageBuilderName(String imageBuilderName)

The name of the image builder that was used to create the private image. If the image is shared, this value is null.

Parameters:

imageBuilderName - The name of the image builder that was used to create the private image. If the image is shared, this value is null.

Returns:

Returns a reference to this object so that method calls can be chained together.

platform

Image.Builder platform(String platform)

The operating system platform of the image.

Parameters:

platform - The operating system platform of the image.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PlatformType, PlatformType

platform

Image.Builder platform(PlatformType platform)

The operating system platform of the image.

Parameters:

platform - The operating system platform of the image.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PlatformType, PlatformType

description

Image.Builder description(String description)

The description to display.

Parameters:

description - The description to display.

Returns:

Returns a reference to this object so that method calls can be chained together.

stateChangeReason

Image.Builder stateChangeReason(ImageStateChangeReason stateChangeReason)

The reason why the last state change occurred.

Parameters:

stateChangeReason - The reason why the last state change occurred.

Returns:

Returns a reference to this object so that method calls can be chained together.

stateChangeReason

default Image.Builder stateChangeReason(Consumer<ImageStateChangeReason.Builder> stateChangeReason)

The reason why the last state change occurred.

This is a convenience method that creates an instance of the ImageStateChangeReason.Builder avoiding the need to create one manually via ImageStateChangeReason.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to stateChangeReason(ImageStateChangeReason).

Parameters:

stateChangeReason - a consumer that will call methods on ImageStateChangeReason.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

stateChangeReason(ImageStateChangeReason)

applications

Image.Builder applications(Collection<Application> applications)

The applications associated with the image.

Parameters:

applications - The applications associated with the image.

Returns:

Returns a reference to this object so that method calls can be chained together.

applications

Image.Builder applications(Application... applications)

The applications associated with the image.

Parameters:

applications - The applications associated with the image.

Returns:

Returns a reference to this object so that method calls can be chained together.

applications

Image.Builder applications(Consumer<Application.Builder>... applications)

The applications associated with the image.

This is a convenience method that creates an instance of the Application.Builder avoiding the need to create one manually via Application.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #applications(List).

Parameters:

applications - a consumer that will call methods on Application.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#applications(java.util.Collection)

createdTime

Image.Builder createdTime(Instant createdTime)

The time the image was created.

Parameters:

createdTime - The time the image was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

publicBaseImageReleasedDate

Image.Builder publicBaseImageReleasedDate(Instant publicBaseImageReleasedDate)

The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.

Parameters:

publicBaseImageReleasedDate - The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

appstreamAgentVersion

Image.Builder appstreamAgentVersion(String appstreamAgentVersion)

The version of the AppStream 2.0 agent to use for instances that are launched from this image.

Parameters:

appstreamAgentVersion - The version of the AppStream 2.0 agent to use for instances that are launched from this image.

Returns:

Returns a reference to this object so that method calls can be chained together.

imagePermissions

Image.Builder imagePermissions(ImagePermissions imagePermissions)

The permissions to provide to the destination AWS account for the specified image.

Parameters:

imagePermissions - The permissions to provide to the destination AWS account for the specified image.

Returns:

Returns a reference to this object so that method calls can be chained together.

imagePermissions

default Image.Builder imagePermissions(Consumer<ImagePermissions.Builder> imagePermissions)

The permissions to provide to the destination AWS account for the specified image.

This is a convenience method that creates an instance of the ImagePermissions.Builder avoiding the need to create one manually via ImagePermissions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to imagePermissions(ImagePermissions).

Parameters:

imagePermissions - a consumer that will call methods on ImagePermissions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

imagePermissions(ImagePermissions)

imageErrors

Image.Builder imageErrors(Collection<ResourceError> imageErrors)

Describes the errors that are returned when a new image can't be created.

Parameters:

imageErrors - Describes the errors that are returned when a new image can't be created.

Returns:

Returns a reference to this object so that method calls can be chained together.

imageErrors

Image.Builder imageErrors(ResourceError... imageErrors)

Describes the errors that are returned when a new image can't be created.

Parameters:

imageErrors - Describes the errors that are returned when a new image can't be created.

Returns:

Returns a reference to this object so that method calls can be chained together.

imageErrors

Image.Builder imageErrors(Consumer<ResourceError.Builder>... imageErrors)

Describes the errors that are returned when a new image can't be created.

This is a convenience method that creates an instance of the ResourceError.Builder avoiding the need to create one manually via ResourceError.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #imageErrors(List).

Parameters:

imageErrors - a consumer that will call methods on ResourceError.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#imageErrors(java.util.Collection)