software.amazon.awssdk.services.appstream.model

Class CreateFleetRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.appstream.model.AppStreamRequest

software.amazon.awssdk.services.appstream.model.CreateFleetRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateFleetRequest
extends AppStreamRequest
implements ToCopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateFleetRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateFleetRequest.Builder	builder()
ComputeCapacity	computeCapacity() The desired capacity for the fleet.
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() Enables or disables default internet access for the fleet.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FleetType	fleetType() The fleet type.
String	fleetTypeAsString() The fleet type.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	iamRoleArn() The Amazon Resource Name (ARN) of the IAM role to apply 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 of the public, private, or shared image to use.
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 amount of time that a streaming session can remain active, in seconds.
String	name() A unique name for the fleet.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateFleetRequest.Builder>	serializableBuilderClass()
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.
Map<String,String>	tags() The tags to associate with the fleet.
CreateFleetRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
VpcConfig	vpcConfig() The VPC configuration for the fleet.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

name

public final String name()

A unique name for the fleet.

Returns:

A unique name for the fleet.

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 of the public, private, or shared image to use.

Returns:

The ARN of the public, private, or shared image to use.

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

computeCapacity

public final ComputeCapacity computeCapacity()

The desired capacity for the fleet.

Returns:

The desired capacity for the fleet.

vpcConfig

public final VpcConfig vpcConfig()

The VPC configuration for the fleet.

Returns:

The VPC configuration 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 users 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 360000.

Returns:

The amount of time that a streaming session remains active after users disconnect. If users 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 360000.

description

public final String description()

The description to display.

Returns:

The description to display.

displayName

public final String displayName()

The fleet name to display.

Returns:

The fleet name to display.

enableDefaultInternetAccess

public final Boolean enableDefaultInternetAccess()

Enables or disables default internet access for the fleet.

Returns:

Enables or disables default internet access 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.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final Map<String,String> tags()

The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

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

You can use hasTags() to see if a value was sent in this field.

Returns:

The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

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 they 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 3600. 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 they 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 3600. 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 Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a 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 Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a 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

toBuilder

public CreateFleetRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>

Specified by:

toBuilder in class AppStreamRequest

builder

public static CreateFleetRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo