@Generated(value="software.amazon.awssdk:codegen") public final class CreateFleetRequest extends AppStreamRequest implements ToCopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateFleetRequest.Builder |
| 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()
For responses, this returns true if the service returned a value for the Tags property.
|
boolean |
hasUsbDeviceFilterStrings()
For responses, this returns true if the service returned a value for the UsbDeviceFilterStrings property.
|
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 |
maxConcurrentSessions()
The maximum concurrent sessions of the Elastic fleet.
|
Integer |
maxUserDurationInSeconds()
The maximum amount of time that a streaming session can remain active, in seconds.
|
String |
name()
A unique name for the fleet.
|
PlatformType |
platform()
The fleet platform.
|
String |
platformAsString()
The fleet platform.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateFleetRequest.Builder> |
serializableBuilderClass() |
S3Location |
sessionScriptS3Location()
The S3 location of the session scripts configuration zip file.
|
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.
|
List<String> |
usbDeviceFilterStrings()
The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session,
when using the Windows native client.
|
VpcConfig |
vpcConfig()
The VPC configuration for the fleet.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String name()
A unique name for the fleet.
public final String imageName()
The name of the image used to create the fleet.
public final String imageArn()
The ARN of the public, private, or shared image to use.
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.standard.xlarge
stream.standard.2xlarge
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
The following instance types are available for Elastic fleets:
stream.standard.small
stream.standard.medium
stream.standard.large
stream.standard.xlarge
stream.standard.2xlarge
stream.standard.small
stream.standard.medium
stream.standard.large
stream.standard.xlarge
stream.standard.2xlarge
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
The following instance types are available for Elastic fleets:
stream.standard.small
stream.standard.medium
stream.standard.large
stream.standard.xlarge
stream.standard.2xlarge
public final FleetType fleetType()
The fleet type.
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.
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().
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.
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.
FleetTypepublic final String fleetTypeAsString()
The fleet type.
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.
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().
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.
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.
FleetTypepublic final ComputeCapacity computeCapacity()
The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.
public final VpcConfig vpcConfig()
The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.
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.
Specify a value between 600 and 360000.
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.
Specify a value between 60 and 360000.
public final String description()
The description to display.
public final String displayName()
The fleet name to display.
public final Boolean enableDefaultInternetAccess()
Enables or disables default internet access for the fleet.
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. This is not allowed for Elastic fleets.
public final boolean hasTags()
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.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.
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 hasTags() method.
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.
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.
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.
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.
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.
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().
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.
StreamViewpublic 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().
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.
StreamViewpublic final PlatformType platform()
The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
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().
PlatformTypepublic final String platformAsString()
The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
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().
PlatformTypepublic final Integer maxConcurrentSessions()
The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.
public final boolean hasUsbDeviceFilterStrings()
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.public final List<String> usbDeviceFilterStrings()
The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.
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.
public final S3Location sessionScriptS3Location()
The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
public CreateFleetRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>toBuilder in class AppStreamRequestpublic static CreateFleetRequest.Builder builder()
public static Class<? extends CreateFleetRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.