Class ImageBuilder
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ImageBuilder.Builder,
ImageBuilder>
Describes a virtual machine that is used to create an image.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<AccessEndpoint> The list of virtual private cloud (VPC) interface endpoint objects.final String
The version of the AppStream 2.0 agent that is currently being used by the image builder.final String
arn()
The ARN for the image builder.static ImageBuilder.Builder
builder()
final Instant
The time stamp when the image builder was created.final String
The description to display.final String
The image builder name to display.final DomainJoinInfo
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.final Boolean
Enables or disables default internet access for the image builder.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AccessEndpoints property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ImageBuilderErrors property.final String
The ARN of the IAM role that is applied to the image builder.final String
imageArn()
The ARN of the image from which this builder was created.final List
<ResourceError> The image builder errors.final String
The instance type for the image builder.final String
name()
The name of the image builder.Returns the value of the NetworkAccessConfiguration property for this object.final PlatformType
platform()
The operating system platform of the image builder.final String
The operating system platform of the image builder.static Class
<? extends ImageBuilder.Builder> final ImageBuilderState
state()
The state of the image builder.final String
The state of the image builder.The reason why the last state change occurred.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final VpcConfig
The VPC configuration of the image builder.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the image builder.
- Returns:
- The name of the image builder.
-
arn
The ARN for the image builder.
- Returns:
- The ARN for the image builder.
-
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
The description to display.
- Returns:
- The description to display.
-
displayName
The image builder name to display.
- Returns:
- The image builder name to display.
-
vpcConfig
The VPC configuration of the image builder.
- Returns:
- The VPC configuration of the image builder.
-
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
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 returnPlatformType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformAsString()
.- Returns:
- The operating system platform of the image builder.
- See Also:
-
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 returnPlatformType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformAsString()
.- Returns:
- The operating system platform of the image builder.
- See Also:
-
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
The state of the image builder.
If the service returns an enum value that is not available in the current SDK version,
state
will returnImageBuilderState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the image builder.
- See Also:
-
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 returnImageBuilderState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the image builder.
- See Also:
-
stateChangeReason
The reason why the last state change occurred.
- Returns:
- The reason why the last state change occurred.
-
createdTime
The time stamp when the image builder was created.
- Returns:
- The time stamp when the image builder was created.
-
enableDefaultInternetAccess
Enables or disables default internet access for the image builder.
- Returns:
- Enables or disables default internet access for the image builder.
-
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
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 theisEmpty()
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
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
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 theisEmpty()
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
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.
-
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 interfaceToCopyableBuilder<ImageBuilder.Builder,
ImageBuilder> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-