Modifier and Type | Method and Description |
---|---|
CfnFleet |
build() |
CfnFleet.Builder |
computeCapacity(CfnFleet.ComputeCapacityProperty computeCapacity)
The desired capacity for the fleet.
|
CfnFleet.Builder |
computeCapacity(IResolvable computeCapacity)
The desired capacity for the fleet.
|
static CfnFleet.Builder |
create(Construct scope,
java.lang.String id) |
CfnFleet.Builder |
description(java.lang.String description)
The description to display.
|
CfnFleet.Builder |
disconnectTimeoutInSeconds(java.lang.Number disconnectTimeoutInSeconds)
The amount of time that a streaming session remains active after users disconnect.
|
CfnFleet.Builder |
displayName(java.lang.String displayName)
The fleet name to display.
|
CfnFleet.Builder |
domainJoinInfo(CfnFleet.DomainJoinInfoProperty domainJoinInfo)
The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
|
CfnFleet.Builder |
domainJoinInfo(IResolvable domainJoinInfo)
The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
|
CfnFleet.Builder |
enableDefaultInternetAccess(java.lang.Boolean enableDefaultInternetAccess)
Enables or disables default internet access for the fleet.
|
CfnFleet.Builder |
enableDefaultInternetAccess(IResolvable enableDefaultInternetAccess)
Enables or disables default internet access for the fleet.
|
CfnFleet.Builder |
fleetType(java.lang.String fleetType)
The fleet type.
|
CfnFleet.Builder |
iamRoleArn(java.lang.String iamRoleArn)
The ARN of the IAM role that is applied to the fleet.
|
CfnFleet.Builder |
idleDisconnectTimeoutInSeconds(java.lang.Number 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.
|
CfnFleet.Builder |
imageArn(java.lang.String imageArn)
The ARN of the public, private, or shared image to use.
|
CfnFleet.Builder |
imageName(java.lang.String imageName)
The name of the image used to create the fleet.
|
CfnFleet.Builder |
instanceType(java.lang.String instanceType)
The instance type to use when launching fleet instances.
|
CfnFleet.Builder |
maxConcurrentSessions(java.lang.Number maxConcurrentSessions)
The maximum number of concurrent sessions that can be run on an Elastic fleet.
|
CfnFleet.Builder |
maxUserDurationInSeconds(java.lang.Number maxUserDurationInSeconds)
The maximum amount of time that a streaming session can remain active, in seconds.
|
CfnFleet.Builder |
name(java.lang.String name)
A unique name for the fleet.
|
CfnFleet.Builder |
platform(java.lang.String platform)
The platform of the fleet.
|
CfnFleet.Builder |
sessionScriptS3Location(CfnFleet.S3LocationProperty sessionScriptS3Location)
The S3 location of the session scripts configuration zip file.
|
CfnFleet.Builder |
sessionScriptS3Location(IResolvable sessionScriptS3Location)
The S3 location of the session scripts configuration zip file.
|
CfnFleet.Builder |
streamView(java.lang.String streamView)
The AppStream 2.0 view that is displayed to your users when they stream from the fleet.
|
CfnFleet.Builder |
tags(java.util.List<? extends CfnTag> tags)
An array of key-value pairs.
|
CfnFleet.Builder |
usbDeviceFilterStrings(java.util.List<java.lang.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.
|
CfnFleet.Builder |
vpcConfig(CfnFleet.VpcConfigProperty vpcConfig)
The VPC configuration for the fleet.
|
CfnFleet.Builder |
vpcConfig(IResolvable vpcConfig)
The VPC configuration for the fleet.
|
public static CfnFleet.Builder create(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.CfnFleet.ComputeCapacityProperty.Builder
.public CfnFleet.Builder instanceType(java.lang.String instanceType)
The following instance types are available for Elastic fleets:
instanceType
- The instance type to use when launching fleet instances. The following instance types are available for non-Elastic fleets:. This parameter is required.this
public CfnFleet.Builder name(java.lang.String name)
name
- A unique name for the fleet. This parameter is required.this
public CfnFleet.Builder computeCapacity(IResolvable computeCapacity)
This is not allowed for Elastic fleets.
computeCapacity
- The desired capacity for the fleet. This parameter is required.this
public CfnFleet.Builder computeCapacity(CfnFleet.ComputeCapacityProperty computeCapacity)
This is not allowed for Elastic fleets.
computeCapacity
- The desired capacity for the fleet. This parameter is required.this
public CfnFleet.Builder description(java.lang.String description)
description
- The description to display. This parameter is required.this
public CfnFleet.Builder disconnectTimeoutInSeconds(java.lang.Number disconnectTimeoutInSeconds)
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. This parameter is required.this
public CfnFleet.Builder displayName(java.lang.String displayName)
displayName
- The fleet name to display. This parameter is required.this
public CfnFleet.Builder domainJoinInfo(IResolvable domainJoinInfo)
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 parameter is required.this
public CfnFleet.Builder domainJoinInfo(CfnFleet.DomainJoinInfoProperty domainJoinInfo)
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 parameter is required.this
public CfnFleet.Builder enableDefaultInternetAccess(java.lang.Boolean enableDefaultInternetAccess)
enableDefaultInternetAccess
- Enables or disables default internet access for the fleet. This parameter is required.this
public CfnFleet.Builder enableDefaultInternetAccess(IResolvable enableDefaultInternetAccess)
enableDefaultInternetAccess
- Enables or disables default internet access for the fleet. This parameter is required.this
public CfnFleet.Builder fleetType(java.lang.String fleetType)
Allowed Values : ALWAYS_ON
| ELASTIC
| ON_DEMAND
fleetType
- The fleet type. This parameter is required.this
public CfnFleet.Builder iamRoleArn(java.lang.String iamRoleArn)
To assume a role, the fleet instance calls the AWS Security Token Service 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 ARN of the IAM role that is applied to the fleet. This parameter is required.this
public CfnFleet.Builder idleDisconnectTimeoutInSeconds(java.lang.Number idleDisconnectTimeoutInSeconds)
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.
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. This parameter is required.this
public CfnFleet.Builder imageArn(java.lang.String imageArn)
imageArn
- The ARN of the public, private, or shared image to use. This parameter is required.this
public CfnFleet.Builder imageName(java.lang.String imageName)
imageName
- The name of the image used to create the fleet. This parameter is required.this
public CfnFleet.Builder maxConcurrentSessions(java.lang.Number maxConcurrentSessions)
This setting is required for Elastic fleets, but is not used for other fleet types.
maxConcurrentSessions
- The maximum number of concurrent sessions that can be run on an Elastic fleet. This parameter is required.this
public CfnFleet.Builder maxUserDurationInSeconds(java.lang.Number maxUserDurationInSeconds)
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. This parameter is required.this
public CfnFleet.Builder platform(java.lang.String platform)
Platform is a required setting for Elastic fleets, and is not used for other fleet types.
Allowed Values : WINDOWS_SERVER_2019
| AMAZON_LINUX2
platform
- The platform of the fleet. This parameter is required.this
public CfnFleet.Builder sessionScriptS3Location(IResolvable sessionScriptS3Location)
This only applies to Elastic fleets.
sessionScriptS3Location
- The S3 location of the session scripts configuration zip file. This parameter is required.this
public CfnFleet.Builder sessionScriptS3Location(CfnFleet.S3LocationProperty sessionScriptS3Location)
This only applies to Elastic fleets.
sessionScriptS3Location
- The S3 location of the session scripts configuration zip file. This parameter is required.this
public CfnFleet.Builder streamView(java.lang.String streamView)
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. This parameter is required.this
public CfnFleet.Builder tags(java.util.List<? extends CfnTag> tags)
tags
- An array of key-value pairs. This parameter is required.this
public CfnFleet.Builder usbDeviceFilterStrings(java.util.List<java.lang.String> usbDeviceFilterStrings)
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 parameter is required.this
public CfnFleet.Builder vpcConfig(IResolvable vpcConfig)
This is required for Elastic fleets, but not required for other fleet types.
vpcConfig
- The VPC configuration for the fleet. This parameter is required.this
public CfnFleet.Builder vpcConfig(CfnFleet.VpcConfigProperty vpcConfig)
This is required for Elastic fleets, but not required for other fleet types.
vpcConfig
- The VPC configuration for the fleet. This parameter is required.this
public CfnFleet build()