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:

  • Method Details

    • 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

      • stream.graphics.g5.xlarge

      • stream.graphics.g5.2xlarge

      • stream.graphics.g5.4xlarge

      • stream.graphics.g5.8xlarge

      • stream.graphics.g5.16xlarge

      • stream.graphics.g5.12xlarge

      • stream.graphics.g5.24xlarge

      • stream.graphics.g6.xlarge

      • stream.graphics.g6.2xlarge

      • stream.graphics.g6.4xlarge

      • stream.graphics.g6.8xlarge

      • stream.graphics.g6.16xlarge

      • stream.graphics.g6.12xlarge

      • stream.graphics.g6.24xlarge

      • stream.graphics.gr6.4xlarge

      • stream.graphics.gr6.8xlarge

      • stream.graphics.g6f.large

      • stream.graphics.g6f.xlarge

      • stream.graphics.g6f.2xlarge

      • stream.graphics.g6f.4xlarge

      • stream.graphics.gr6f.4xlarge

      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

      • stream.graphics.g5.xlarge

      • stream.graphics.g5.2xlarge

      • stream.graphics.g5.4xlarge

      • stream.graphics.g5.8xlarge

      • stream.graphics.g5.16xlarge

      • stream.graphics.g5.12xlarge

      • stream.graphics.g5.24xlarge

      • stream.graphics.g6.xlarge

      • stream.graphics.g6.2xlarge

      • stream.graphics.g6.4xlarge

      • stream.graphics.g6.8xlarge

      • stream.graphics.g6.16xlarge

      • stream.graphics.g6.12xlarge

      • stream.graphics.g6.24xlarge

      • stream.graphics.gr6.4xlarge

      • stream.graphics.gr6.8xlarge

      • stream.graphics.g6f.large

      • stream.graphics.g6f.xlarge

      • stream.graphics.g6f.2xlarge

      • stream.graphics.g6f.4xlarge

      • stream.graphics.gr6f.4xlarge

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

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

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

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

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

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

    • toBuilder

      public ImageBuilder.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ImageBuilder.Builder,ImageBuilder>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.