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

Class Fleet

java.lang.Object

software.amazon.awssdk.services.appstream.model.Fleet

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Fleet.Builder,Fleet>

@Generated("software.amazon.awssdk:codegen")
public final class Fleet
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Fleet.Builder,Fleet>

Describes a fleet.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Fleet.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) for the fleet.
static Fleet.Builder	builder()
ComputeCapacityStatus	computeCapacityStatus()	The capacity status for the fleet.
Instant	createdTime()	The time the fleet was created.
String	description()	The description to display.
Integer	disconnectTimeoutInSeconds()	The amount of time that a streaming session remains active after users disconnect.
String	displayName()	The fleet name to display.
DomainJoinInfo	domainJoinInfo()	The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
Boolean	enableDefaultInternetAccess()	Indicates whether default internet access is enabled for the fleet.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<FleetError>	fleetErrors()	The fleet errors.
FleetType	fleetType()	The fleet type.
String	fleetTypeAsString()	The fleet type.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFleetErrors()	For responses, this returns true if the service returned a value for the FleetErrors property.
int	hashCode()
boolean	hasUsbDeviceFilterStrings()	For responses, this returns true if the service returned a value for the UsbDeviceFilterStrings property.
String	iamRoleArn()	The ARN of the IAM role that is applied to the fleet.
Integer	idleDisconnectTimeoutInSeconds()	The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins.
String	imageArn()	The ARN for the public, private, or shared image.
String	imageName()	The name of the image used to create the fleet.
String	instanceType()	The instance type to use when launching fleet instances.
Integer	maxConcurrentSessions()	The maximum number of concurrent sessions for the fleet.
Integer	maxSessionsPerInstance()	The maximum number of user sessions on an instance.
Integer	maxUserDurationInSeconds()	The maximum amount of time that a streaming session can remain active, in seconds.
String	name()	The name of the fleet.
PlatformType	platform()	The platform of the fleet.
String	platformAsString()	The platform of the fleet.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Fleet.Builder>	serializableBuilderClass()
S3Location	sessionScriptS3Location()	The S3 location of the session scripts configuration zip file.
FleetState	state()	The current state for the fleet.
String	stateAsString()	The current state for the fleet.
StreamView	streamView()	The AppStream 2.0 view that is displayed to your users when they stream from the fleet.
String	streamViewAsString()	The AppStream 2.0 view that is displayed to your users when they stream from the fleet.
Fleet.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	usbDeviceFilterStrings()	The USB device filter strings associated with the fleet.
VpcConfig	vpcConfig()	The VPC configuration for the fleet.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

arn

public final String arn()

The Amazon Resource Name (ARN) for the fleet.

Returns:

The Amazon Resource Name (ARN) for the fleet.

name

public final String name()

The name of the fleet.

Returns:

The name of the fleet.

displayName

public final String displayName()

The fleet name to display.

Returns:

The fleet name to display.

description

public final String description()

The description to display.

Returns:

The description to display.

imageName

public final String imageName()

The name of the image used to create the fleet.

Returns:

The name of the image used to create the fleet.

imageArn

public final String imageArn()

The ARN for the public, private, or shared image.

Returns:

The ARN for the public, private, or shared image.

instanceType

public final String instanceType()

The instance type to use when launching fleet instances. 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 to use when launching fleet instances. 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

fleetType

public final FleetType fleetType()

The fleet type.

ALWAYS_ON

Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.

ON_DEMAND

Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.

If the service returns an enum value that is not available in the current SDK version, fleetType will return FleetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fleetTypeAsString().

Returns:

The fleet type.

ALWAYS_ON

Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.

ON_DEMAND

Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.

See Also:

FleetType

fleetTypeAsString

public final String fleetTypeAsString()

The fleet type.

ALWAYS_ON

Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.

ON_DEMAND

Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.

If the service returns an enum value that is not available in the current SDK version, fleetType will return FleetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fleetTypeAsString().

Returns:

The fleet type.

ALWAYS_ON

Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.

ON_DEMAND

Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.

See Also:

FleetType

computeCapacityStatus

public final ComputeCapacityStatus computeCapacityStatus()

The capacity status for the fleet.

Returns:

The capacity status for the fleet.

maxUserDurationInSeconds

public final Integer maxUserDurationInSeconds()

The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

Specify a value between 600 and 360000.

Returns:

The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

Specify a value between 600 and 360000.

disconnectTimeoutInSeconds

public final Integer disconnectTimeoutInSeconds()

The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

Specify a value between 60 and 36000.

Returns:

The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

Specify a value between 60 and 36000.

state

public final FleetState state()

The current state for the fleet.

If the service returns an enum value that is not available in the current SDK version, state will return FleetState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The current state for the fleet.

See Also:

FleetState

stateAsString

public final String stateAsString()

The current state for the fleet.

If the service returns an enum value that is not available in the current SDK version, state will return FleetState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The current state for the fleet.

See Also:

FleetState

vpcConfig

public final VpcConfig vpcConfig()

The VPC configuration for the fleet.

Returns:

The VPC configuration for the fleet.

createdTime

public final Instant createdTime()

The time the fleet was created.

Returns:

The time the fleet was created.

hasFleetErrors

public final boolean hasFleetErrors()

For responses, this returns true if the service returned a value for the FleetErrors 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.

fleetErrors

public final List<FleetError> fleetErrors()

The fleet 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 hasFleetErrors() method.

Returns:

The fleet errors.

enableDefaultInternetAccess

public final Boolean enableDefaultInternetAccess()

Indicates whether default internet access is enabled for the fleet.

Returns:

Indicates whether default internet access is enabled for the fleet.

domainJoinInfo

public final DomainJoinInfo domainJoinInfo()

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

Returns:

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

idleDisconnectTimeoutInSeconds

public final Integer idleDisconnectTimeoutInSeconds()

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.

To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.

If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.

Returns:

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.

To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.

If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.

iamRoleArn

public final String iamRoleArn()

The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance 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 fleet. To assume a role, the fleet instance 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.

streamView

public final StreamView streamView()

The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

The default value is APP.

If the service returns an enum value that is not available in the current SDK version, streamView will return StreamView.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from streamViewAsString().

Returns:

The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

The default value is APP.

See Also:

StreamView

streamViewAsString

public final String streamViewAsString()

The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

The default value is APP.

If the service returns an enum value that is not available in the current SDK version, streamView will return StreamView.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from streamViewAsString().

Returns:

The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

The default value is APP.

See Also:

StreamView

platform

public final PlatformType platform()

The platform of the fleet.

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 platform of the fleet.

See Also:

PlatformType

platformAsString

public final String platformAsString()

The platform of the fleet.

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 platform of the fleet.

See Also:

PlatformType

maxConcurrentSessions

public final Integer maxConcurrentSessions()

The maximum number of concurrent sessions for the fleet.

Returns:

The maximum number of concurrent sessions for the fleet.

hasUsbDeviceFilterStrings

public final boolean hasUsbDeviceFilterStrings()

For responses, this returns true if the service returned a value for the UsbDeviceFilterStrings 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.

usbDeviceFilterStrings

public final List<String> usbDeviceFilterStrings()

The USB device filter strings associated with the fleet.

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 hasUsbDeviceFilterStrings() method.

Returns:

The USB device filter strings associated with the fleet.

sessionScriptS3Location

public final S3Location sessionScriptS3Location()

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

Returns:

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

maxSessionsPerInstance

public final Integer maxSessionsPerInstance()

The maximum number of user sessions on an instance. This only applies to multi-session fleets.

Returns:

The maximum number of user sessions on an instance. This only applies to multi-session fleets.

toBuilder

public Fleet.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Fleet.Builder,Fleet>

builder

public static Fleet.Builder builder()

serializableBuilderClass

public static Class<? extends Fleet.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo