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

Interface Image.Builder

    • 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.

      • 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.

      • 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.

      • latestAppstreamAgentVersion

        Image.Builder latestAppstreamAgentVersion​(String latestAppstreamAgentVersion)

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

        Parameters:
        latestAppstreamAgentVersion - Indicates whether the image is using the latest AppStream 2.0 agent version or not.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LatestAppstreamAgentVersion, LatestAppstreamAgentVersion

      • latestAppstreamAgentVersion

        Image.Builder latestAppstreamAgentVersion​(LatestAppstreamAgentVersion latestAppstreamAgentVersion)

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

        Parameters:
        latestAppstreamAgentVersion - Indicates whether the image is using the latest AppStream 2.0 agent version or not.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LatestAppstreamAgentVersion, LatestAppstreamAgentVersion

      • supportedInstanceFamilies

        Image.Builder supportedInstanceFamilies​(Collection<String> supportedInstanceFamilies)

        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:

        • General Purpose

        • Compute Optimized

        • Memory Optimized

        • Graphics

        • Graphics Design

        • Graphics Pro

        • Graphics G4

        • Graphics G5

        Parameters:
        supportedInstanceFamilies - 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:

        • General Purpose

        • Compute Optimized

        • Memory Optimized

        • Graphics

        • Graphics Design

        • Graphics Pro

        • Graphics G4

        • Graphics G5

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

      • supportedInstanceFamilies

        Image.Builder supportedInstanceFamilies​(String... supportedInstanceFamilies)

        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:

        • General Purpose

        • Compute Optimized

        • Memory Optimized

        • Graphics

        • Graphics Design

        • Graphics Pro

        • Graphics G4

        • Graphics G5

        Parameters:
        supportedInstanceFamilies - 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:

        • General Purpose

        • Compute Optimized

        • Memory Optimized

        • Graphics

        • Graphics Design

        • Graphics Pro

        • Graphics G4

        • Graphics G5

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

      • dynamicAppProvidersEnabled

        Image.Builder dynamicAppProvidersEnabled​(String dynamicAppProvidersEnabled)

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

        Parameters:
        dynamicAppProvidersEnabled - Indicates whether dynamic app providers are enabled within an AppStream 2.0 image or not.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DynamicAppProvidersEnabled, DynamicAppProvidersEnabled

      • dynamicAppProvidersEnabled

        Image.Builder dynamicAppProvidersEnabled​(DynamicAppProvidersEnabled dynamicAppProvidersEnabled)

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

        Parameters:
        dynamicAppProvidersEnabled - Indicates whether dynamic app providers are enabled within an AppStream 2.0 image or not.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DynamicAppProvidersEnabled, DynamicAppProvidersEnabled

      • imageSharedWithOthers

        Image.Builder imageSharedWithOthers​(String imageSharedWithOthers)

        Indicates whether the image is shared with another account ID.

        Parameters:
        imageSharedWithOthers - Indicates whether the image is shared with another account ID.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ImageSharedWithOthers, ImageSharedWithOthers

      • imageSharedWithOthers

        Image.Builder imageSharedWithOthers​(ImageSharedWithOthers imageSharedWithOthers)

        Indicates whether the image is shared with another account ID.

        Parameters:
        imageSharedWithOthers - Indicates whether the image is shared with another account ID.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ImageSharedWithOthers, ImageSharedWithOthers