public static interface CreateFleetRequest.Builder extends AppStreamRequest.Builder, SdkPojo, CopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateFleetRequest.Builder |
computeCapacity(ComputeCapacity computeCapacity)
The desired capacity for the fleet.
|
default CreateFleetRequest.Builder |
computeCapacity(Consumer<ComputeCapacity.Builder> computeCapacity)
The desired capacity for the fleet.
|
CreateFleetRequest.Builder |
description(String description)
The description to display.
|
CreateFleetRequest.Builder |
disconnectTimeoutInSeconds(Integer disconnectTimeoutInSeconds)
The amount of time that a streaming session remains active after users disconnect.
|
CreateFleetRequest.Builder |
displayName(String displayName)
The fleet name to display.
|
default CreateFleetRequest.Builder |
domainJoinInfo(Consumer<DomainJoinInfo.Builder> domainJoinInfo)
The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active
Directory domain.
|
CreateFleetRequest.Builder |
domainJoinInfo(DomainJoinInfo domainJoinInfo)
The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active
Directory domain.
|
CreateFleetRequest.Builder |
enableDefaultInternetAccess(Boolean enableDefaultInternetAccess)
Enables or disables default internet access for the fleet.
|
CreateFleetRequest.Builder |
fleetType(FleetType fleetType)
The fleet type.
|
CreateFleetRequest.Builder |
fleetType(String fleetType)
The fleet type.
|
CreateFleetRequest.Builder |
iamRoleArn(String iamRoleArn)
The Amazon Resource Name (ARN) of the IAM role to apply to the fleet.
|
CreateFleetRequest.Builder |
idleDisconnectTimeoutInSeconds(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. |
CreateFleetRequest.Builder |
imageArn(String imageArn)
The ARN of the public, private, or shared image to use.
|
CreateFleetRequest.Builder |
imageName(String imageName)
The name of the image used to create the fleet.
|
CreateFleetRequest.Builder |
instanceType(String instanceType)
The instance type to use when launching fleet instances.
|
CreateFleetRequest.Builder |
maxConcurrentSessions(Integer maxConcurrentSessions)
The maximum concurrent sessions of the Elastic fleet.
|
CreateFleetRequest.Builder |
maxUserDurationInSeconds(Integer maxUserDurationInSeconds)
The maximum amount of time that a streaming session can remain active, in seconds.
|
CreateFleetRequest.Builder |
name(String name)
A unique name for the fleet.
|
CreateFleetRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateFleetRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateFleetRequest.Builder |
platform(PlatformType platform)
The fleet platform.
|
CreateFleetRequest.Builder |
platform(String platform)
The fleet platform.
|
default CreateFleetRequest.Builder |
sessionScriptS3Location(Consumer<S3Location.Builder> sessionScriptS3Location)
The S3 location of the session scripts configuration zip file.
|
CreateFleetRequest.Builder |
sessionScriptS3Location(S3Location sessionScriptS3Location)
The S3 location of the session scripts configuration zip file.
|
CreateFleetRequest.Builder |
streamView(StreamView streamView)
The AppStream 2.0 view that is displayed to your users when they stream from the fleet.
|
CreateFleetRequest.Builder |
streamView(String streamView)
The AppStream 2.0 view that is displayed to your users when they stream from the fleet.
|
CreateFleetRequest.Builder |
tags(Map<String,String> tags)
The tags to associate with the fleet.
|
CreateFleetRequest.Builder |
usbDeviceFilterStrings(Collection<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.
|
CreateFleetRequest.Builder |
usbDeviceFilterStrings(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.
|
default CreateFleetRequest.Builder |
vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)
The VPC configuration for the fleet.
|
CreateFleetRequest.Builder |
vpcConfig(VpcConfig vpcConfig)
The VPC configuration for the fleet.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateFleetRequest.Builder name(String name)
A unique name for the fleet.
name - A unique name for the fleet.CreateFleetRequest.Builder imageName(String imageName)
The name of the image used to create the fleet.
imageName - The name of the image used to create the fleet.CreateFleetRequest.Builder imageArn(String imageArn)
The ARN of the public, private, or shared image to use.
imageArn - The ARN of the public, private, or shared image to use.CreateFleetRequest.Builder instanceType(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
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
CreateFleetRequest.Builder fleetType(String 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.
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.
FleetType,
FleetTypeCreateFleetRequest.Builder fleetType(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.
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.
FleetType,
FleetTypeCreateFleetRequest.Builder computeCapacity(ComputeCapacity computeCapacity)
The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.
computeCapacity - The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets,
specify MaxConcurrentSessions instead.default CreateFleetRequest.Builder computeCapacity(Consumer<ComputeCapacity.Builder> computeCapacity)
The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.
This is a convenience method that creates an instance of theComputeCapacity.Builder avoiding the
need to create one manually via ComputeCapacity.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to computeCapacity(ComputeCapacity).
computeCapacity - a consumer that will call methods on ComputeCapacity.BuildercomputeCapacity(ComputeCapacity)CreateFleetRequest.Builder vpcConfig(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.
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.default CreateFleetRequest.Builder vpcConfig(Consumer<VpcConfig.Builder> 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.
This is a convenience method that creates an instance of theVpcConfig.Builder avoiding the need to
create one manually via VpcConfig.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result
is passed to vpcConfig(VpcConfig).
vpcConfig - a consumer that will call methods on VpcConfig.BuildervpcConfig(VpcConfig)CreateFleetRequest.Builder maxUserDurationInSeconds(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.
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.
CreateFleetRequest.Builder disconnectTimeoutInSeconds(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.
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.
CreateFleetRequest.Builder description(String description)
The description to display.
description - The description to display.CreateFleetRequest.Builder displayName(String displayName)
The fleet name to display.
displayName - The fleet name to display.CreateFleetRequest.Builder enableDefaultInternetAccess(Boolean enableDefaultInternetAccess)
Enables or disables default internet access for the fleet.
enableDefaultInternetAccess - Enables or disables default internet access for the fleet.CreateFleetRequest.Builder domainJoinInfo(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.
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.default CreateFleetRequest.Builder domainJoinInfo(Consumer<DomainJoinInfo.Builder> 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.
This is a convenience method that creates an instance of theDomainJoinInfo.Builder avoiding the need
to create one manually via DomainJoinInfo.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to domainJoinInfo(DomainJoinInfo).
domainJoinInfo - a consumer that will call methods on DomainJoinInfo.BuilderdomainJoinInfo(DomainJoinInfo)CreateFleetRequest.Builder tags(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.
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.
CreateFleetRequest.Builder idleDisconnectTimeoutInSeconds(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.
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.
CreateFleetRequest.Builder iamRoleArn(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.
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.
CreateFleetRequest.Builder streamView(String 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.
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.
StreamView,
StreamViewCreateFleetRequest.Builder streamView(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.
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.
StreamView,
StreamViewCreateFleetRequest.Builder platform(String platform)
The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
platform - The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.PlatformType,
PlatformTypeCreateFleetRequest.Builder platform(PlatformType platform)
The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
platform - The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.PlatformType,
PlatformTypeCreateFleetRequest.Builder maxConcurrentSessions(Integer maxConcurrentSessions)
The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.
maxConcurrentSessions - The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not
allowed for other fleet types.CreateFleetRequest.Builder usbDeviceFilterStrings(Collection<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.
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.CreateFleetRequest.Builder usbDeviceFilterStrings(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.
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.CreateFleetRequest.Builder sessionScriptS3Location(S3Location sessionScriptS3Location)
The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
sessionScriptS3Location - The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.default CreateFleetRequest.Builder sessionScriptS3Location(Consumer<S3Location.Builder> sessionScriptS3Location)
The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
This is a convenience method that creates an instance of theS3Location.Builder avoiding the need to
create one manually via S3Location.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result
is passed to sessionScriptS3Location(S3Location).
sessionScriptS3Location - a consumer that will call methods on S3Location.BuildersessionScriptS3Location(S3Location)CreateFleetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateFleetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.