appstream/aws.sdk.kotlin.services.appstream.model/Image/Builder

Builder

Properties

var applications: List<Application>?

The applications associated with the image.

appstreamAgentVersion

var appstreamAgentVersion: String?

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

var arn: String?

The ARN of the image.

var baseImageArn: String?

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

var createdTime: Instant?

The time the image was created.

var description: String?

The description to display.

var displayName: String?

The image name to display.

dynamicAppProvidersEnabled

var dynamicAppProvidersEnabled: DynamicAppProvidersEnabled?

Indicates whether dynamic app providers are enabled within an AppStream 2.0 image or not.

imageBuilderName

var imageBuilderName: String?

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

imageBuilderSupported

var imageBuilderSupported: Boolean?

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

var imageErrors: List<ResourceError>?

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

imagePermissions

var imagePermissions: ImagePermissions?

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

imageSharedWithOthers

var imageSharedWithOthers: ImageSharedWithOthers?

Indicates whether the image is shared with another account ID.

latestAppstreamAgentVersion

var latestAppstreamAgentVersion: LatestAppstreamAgentVersion?

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

var name: String?

The name of the image.

var platform: PlatformType?

The operating system platform of the image.

publicBaseImageReleasedDate

var publicBaseImageReleasedDate: Instant?

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.

var state: ImageState?

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

stateChangeReason

var stateChangeReason: ImageStateChangeReason?

The reason why the last state change occurred.

supportedInstanceFamilies

var supportedInstanceFamilies: List<String>?

The supported instances families that determine which image a customer can use when the customer launches a fleet or image builder. The following instances families are supported:

var visibility: VisibilityType?

Indicates whether the image is public or private.

Functions

imagePermissions

fun imagePermissions(block: ImagePermissions.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.appstream.model.ImagePermissions inside the given block

stateChangeReason

fun stateChangeReason(block: ImageStateChangeReason.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.appstream.model.ImageStateChangeReason inside the given block