Package software.amazon.awscdk.services.appstream

Class CfnFleet.Builder

java.lang.Object

software.amazon.awscdk.services.appstream.CfnFleet.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFleet>

Enclosing class:

CfnFleet

@Stability(Stable)
public static final class CfnFleet.Builder
extends Object
implements software.amazon.jsii.Builder<CfnFleet>

A fluent builder for CfnFleet.

Method Summary

Modifier and Type	Method	Description
CfnFleet	build()
CfnFleet.Builder	computeCapacity(IResolvable computeCapacity)	The desired capacity for the fleet.
CfnFleet.Builder	computeCapacity(CfnFleet.ComputeCapacityProperty computeCapacity)	The desired capacity for the fleet.
static CfnFleet.Builder	create(software.constructs.Construct scope, String id)
CfnFleet.Builder	description(String description)	The description to display.
CfnFleet.Builder	disconnectTimeoutInSeconds(Number disconnectTimeoutInSeconds)	The amount of time that a streaming session remains active after users disconnect.
CfnFleet.Builder	displayName(String displayName)	The fleet name to display.
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	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	enableDefaultInternetAccess(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(String fleetType)	The fleet type.
CfnFleet.Builder	iamRoleArn(String iamRoleArn)	The ARN of the IAM role that is applied to the fleet.
CfnFleet.Builder	idleDisconnectTimeoutInSeconds(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(String imageArn)	The ARN of the public, private, or shared image to use.
CfnFleet.Builder	imageName(String imageName)	The name of the image used to create the fleet.
CfnFleet.Builder	instanceType(String instanceType)	The instance type to use when launching fleet instances.
CfnFleet.Builder	maxConcurrentSessions(Number maxConcurrentSessions)	The maximum number of concurrent sessions that can be run on an Elastic fleet.
CfnFleet.Builder	maxSessionsPerInstance(Number maxSessionsPerInstance)	Max number of user sessions on an instance.
CfnFleet.Builder	maxUserDurationInSeconds(Number maxUserDurationInSeconds)	The maximum amount of time that a streaming session can remain active, in seconds.
CfnFleet.Builder	name(String name)	A unique name for the fleet.
CfnFleet.Builder	platform(String platform)	The platform of the fleet.
CfnFleet.Builder	sessionScriptS3Location(IResolvable sessionScriptS3Location)	The S3 location of the session scripts configuration zip file.
CfnFleet.Builder	sessionScriptS3Location(CfnFleet.S3LocationProperty sessionScriptS3Location)	The S3 location of the session scripts configuration zip file.
CfnFleet.Builder	streamView(String streamView)	The AppStream 2.0 view that is displayed to your users when they stream from the fleet.
CfnFleet.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs.
CfnFleet.Builder	usbDeviceFilterStrings(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.
CfnFleet.Builder	vpcConfig(IResolvable vpcConfig)	The VPC configuration for the fleet.
CfnFleet.Builder	vpcConfig(CfnFleet.VpcConfigProperty vpcConfig)	The VPC configuration for the fleet.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnFleet.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnFleet.Builder.

instanceType

@Stability(Stable)
public CfnFleet.Builder instanceType(String instanceType)

The instance type to use when launching fleet instances. The following instance types are available for non-Elastic fleets:.

• 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

The following instance types are available for Elastic fleets:

• stream.standard.small
• stream.standard.medium

Parameters:

instanceType - The instance type to use when launching fleet instances. The following instance types are available for non-Elastic fleets:. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-instancetype

name

@Stability(Stable)
public CfnFleet.Builder name(String name)

A unique name for the fleet.

Parameters:

name - A unique name for the fleet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-name

computeCapacity

@Stability(Stable)
public CfnFleet.Builder computeCapacity(IResolvable computeCapacity)

The desired capacity for the fleet.

This is not allowed for Elastic fleets.

Parameters:

computeCapacity - The desired capacity for the fleet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-computecapacity

computeCapacity

@Stability(Stable)
public CfnFleet.Builder computeCapacity(CfnFleet.ComputeCapacityProperty computeCapacity)

The desired capacity for the fleet.

This is not allowed for Elastic fleets.

Parameters:

computeCapacity - The desired capacity for the fleet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-computecapacity

description

@Stability(Stable)
public CfnFleet.Builder description(String description)

The description to display.

Parameters:

description - The description to display. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-description

disconnectTimeoutInSeconds

@Stability(Stable)
public CfnFleet.Builder disconnectTimeoutInSeconds(Number 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 36000.

Parameters:

disconnectTimeoutInSeconds - The amount of time that a streaming session remains active after users disconnect. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-disconnecttimeoutinseconds

displayName

@Stability(Stable)
public CfnFleet.Builder displayName(String displayName)

The fleet name to display.

Parameters:

displayName - The fleet name to display. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-displayname

domainJoinInfo

@Stability(Stable)
public 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.

This is not allowed for Elastic fleets.

Parameters:

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.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-domainjoininfo

domainJoinInfo

@Stability(Stable)
public 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.

This is not allowed for Elastic fleets.

Parameters:

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.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-domainjoininfo

enableDefaultInternetAccess

@Stability(Stable)
public CfnFleet.Builder enableDefaultInternetAccess(Boolean enableDefaultInternetAccess)

Enables or disables default internet access for the fleet.

Parameters:

enableDefaultInternetAccess - Enables or disables default internet access for the fleet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-enabledefaultinternetaccess

enableDefaultInternetAccess

@Stability(Stable)
public CfnFleet.Builder enableDefaultInternetAccess(IResolvable enableDefaultInternetAccess)

Enables or disables default internet access for the fleet.

Parameters:

enableDefaultInternetAccess - Enables or disables default internet access for the fleet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-enabledefaultinternetaccess

fleetType

@Stability(Stable)
public CfnFleet.Builder fleetType(String 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.
• ELASTIC - The pool of streaming instances is managed by Amazon AppStream 2.0. When a user selects their application or desktop to launch, they will start streaming after the app block has been downloaded and mounted to a streaming instance.

Allowed Values : ALWAYS_ON | ELASTIC | ON_DEMAND

Parameters:

fleetType - The fleet type. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-fleettype

iamRoleArn

@Stability(Stable)
public CfnFleet.Builder iamRoleArn(String iamRoleArn)

The ARN of the IAM role that is applied to the fleet.

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 .

Parameters:

iamRoleArn - The ARN of the IAM role that is applied to the fleet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-iamrolearn

idleDisconnectTimeoutInSeconds

@Stability(Stable)
public CfnFleet.Builder idleDisconnectTimeoutInSeconds(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.

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

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.

Parameters:

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.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-idledisconnecttimeoutinseconds

imageArn

@Stability(Stable)
public CfnFleet.Builder imageArn(String imageArn)

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

Parameters:

imageArn - The ARN of the public, private, or shared image to use. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-imagearn

imageName

@Stability(Stable)
public CfnFleet.Builder imageName(String imageName)

The name of the image used to create the fleet.

Parameters:

imageName - The name of the image used to create the fleet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-imagename

maxConcurrentSessions

@Stability(Stable)
public CfnFleet.Builder maxConcurrentSessions(Number maxConcurrentSessions)

The maximum number of concurrent sessions that can be run on an Elastic fleet.

This setting is required for Elastic fleets, but is not used for other fleet types.

Parameters:

maxConcurrentSessions - The maximum number of concurrent sessions that can be run on an Elastic fleet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-maxconcurrentsessions

maxSessionsPerInstance

@Stability(Stable)
public CfnFleet.Builder maxSessionsPerInstance(Number maxSessionsPerInstance)

Max number of user sessions on an instance.

This is applicable only for multi-session fleets.

Parameters:

maxSessionsPerInstance - Max number of user sessions on an instance. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-maxsessionsperinstance

maxUserDurationInSeconds

@Stability(Stable)
public CfnFleet.Builder maxUserDurationInSeconds(Number 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 432000.

Parameters:

maxUserDurationInSeconds - The maximum amount of time that a streaming session can remain active, in seconds. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-maxuserdurationinseconds

platform

@Stability(Stable)
public CfnFleet.Builder platform(String platform)

The platform of the fleet.

Platform is a required setting for Elastic fleets, and is not used for other fleet types.

Parameters:

platform - The platform of the fleet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-platform

sessionScriptS3Location

@Stability(Stable)
public CfnFleet.Builder sessionScriptS3Location(IResolvable sessionScriptS3Location)

The S3 location of the session scripts configuration zip file.

This only applies to Elastic fleets.

Parameters:

sessionScriptS3Location - The S3 location of the session scripts configuration zip file. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-sessionscripts3location

sessionScriptS3Location

@Stability(Stable)
public CfnFleet.Builder sessionScriptS3Location(CfnFleet.S3LocationProperty sessionScriptS3Location)

The S3 location of the session scripts configuration zip file.

This only applies to Elastic fleets.

Parameters:

sessionScriptS3Location - The S3 location of the session scripts configuration zip file. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-sessionscripts3location

streamView

@Stability(Stable)
public CfnFleet.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 .

Parameters:

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.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-streamview

tags

@Stability(Stable)
public CfnFleet.Builder tags(List<? extends CfnTag> tags)

An array of key-value pairs.

Parameters:

tags - An array of key-value pairs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-tags

usbDeviceFilterStrings

@Stability(Stable)
public CfnFleet.Builder usbDeviceFilterStrings(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.

Parameters:

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.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-usbdevicefilterstrings

vpcConfig

@Stability(Stable)
public CfnFleet.Builder vpcConfig(IResolvable vpcConfig)

The VPC configuration for the fleet.

This is required for Elastic fleets, but not required for other fleet types.

Parameters:

vpcConfig - The VPC configuration for the fleet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-vpcconfig

vpcConfig

@Stability(Stable)
public CfnFleet.Builder vpcConfig(CfnFleet.VpcConfigProperty vpcConfig)

The VPC configuration for the fleet.

This is required for Elastic fleets, but not required for other fleet types.

Parameters:

vpcConfig - The VPC configuration for the fleet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html#cfn-appstream-fleet-vpcconfig

build

@Stability(Stable)
public CfnFleet build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnFleet>

Returns:

a newly built instance of CfnFleet.