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(value="software.amazon.awssdk:codegen")
public final class Fleet
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Fleet.Builder,Fleet>

Contains the parameters for a fleet.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Fleet.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The 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 for display.
Integer	disconnectTimeoutInSeconds() The time after disconnection when a session is considered to have ended, in seconds.
String	displayName() The fleet name for display.
DomainJoinInfo	domainJoinInfo() The information needed to join a Microsoft Active Directory domain.
Boolean	enableDefaultInternetAccess() Indicates whether default internet access is enabled for the fleet.
boolean	equals(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)
int	hashCode()
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	maxUserDurationInSeconds() The maximum time that a streaming session can run, in seconds.
String	name() The name of the fleet.
List<SdkField<?>>	sdkFields()
static Class<? extends Fleet.Builder>	serializableBuilderClass()
FleetState	state() The current state for the fleet.
String	stateAsString() The current state for the fleet.
Fleet.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
VpcConfig	vpcConfig() The VPC configuration for the fleet.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

arn

public String arn()

The ARN for the fleet.

Returns:

The ARN for the fleet.

name

public String name()

The name of the fleet.

Returns:

The name of the fleet.

displayName

public String displayName()

The fleet name for display.

Returns:

The fleet name for display.

description

public String description()

The description for display.

Returns:

The description for display.

imageName

public 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 String imageArn()

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

Returns:

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

instanceType

public String instanceType()

The instance type to use when launching fleet instances.

Returns:

The instance type to use when launching fleet instances.

fleetType

public 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 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 ComputeCapacityStatus computeCapacityStatus()

The capacity status for the fleet.

Returns:

The capacity status for the fleet.

maxUserDurationInSeconds

public Integer maxUserDurationInSeconds()

The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.

Returns:

The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.

disconnectTimeoutInSeconds

public Integer disconnectTimeoutInSeconds()

The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.

Returns:

The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.

state

public 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 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 VpcConfig vpcConfig()

The VPC configuration for the fleet.

Returns:

The VPC configuration for the fleet.

createdTime

public Instant createdTime()

The time the fleet was created.

Returns:

The time the fleet was created.

fleetErrors

public List<FleetError> fleetErrors()

The fleet errors.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The fleet errors.

enableDefaultInternetAccess

public 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 DomainJoinInfo domainJoinInfo()

The information needed to join a Microsoft Active Directory domain.

Returns:

The information needed to join a Microsoft Active Directory domain.

toBuilder

public Fleet.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<Fleet.Builder,Fleet>

Returns:

a builder for type T

builder

public static Fleet.Builder builder()

serializableBuilderClass

public static Class<? extends Fleet.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

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