software.amazon.awscdk.services.appstream

Class CfnFleetProps.Builder

java.lang.Object

software.amazon.awscdk.services.appstream.CfnFleetProps.Builder

Enclosing interface:

CfnFleetProps

public static final class CfnFleetProps.Builder
extends java.lang.Object

A builder for CfnFleetProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnFleetProps	build() Builds the configured instance.
CfnFleetProps.Builder	computeCapacity(CfnFleet.ComputeCapacityProperty computeCapacity) Sets the value of CfnFleetProps.getComputeCapacity()
CfnFleetProps.Builder	computeCapacity(IResolvable computeCapacity) Sets the value of CfnFleetProps.getComputeCapacity()
CfnFleetProps.Builder	description(java.lang.String description) Sets the value of CfnFleetProps.getDescription()
CfnFleetProps.Builder	disconnectTimeoutInSeconds(java.lang.Number disconnectTimeoutInSeconds) Sets the value of CfnFleetProps.getDisconnectTimeoutInSeconds()
CfnFleetProps.Builder	displayName(java.lang.String displayName) Sets the value of CfnFleetProps.getDisplayName()
CfnFleetProps.Builder	domainJoinInfo(CfnFleet.DomainJoinInfoProperty domainJoinInfo) Sets the value of CfnFleetProps.getDomainJoinInfo()
CfnFleetProps.Builder	domainJoinInfo(IResolvable domainJoinInfo) Sets the value of CfnFleetProps.getDomainJoinInfo()
CfnFleetProps.Builder	enableDefaultInternetAccess(java.lang.Boolean enableDefaultInternetAccess) Sets the value of CfnFleetProps.getEnableDefaultInternetAccess()
CfnFleetProps.Builder	enableDefaultInternetAccess(IResolvable enableDefaultInternetAccess) Sets the value of CfnFleetProps.getEnableDefaultInternetAccess()
CfnFleetProps.Builder	fleetType(java.lang.String fleetType) Sets the value of CfnFleetProps.getFleetType()
CfnFleetProps.Builder	iamRoleArn(java.lang.String iamRoleArn) Sets the value of CfnFleetProps.getIamRoleArn()
CfnFleetProps.Builder	idleDisconnectTimeoutInSeconds(java.lang.Number idleDisconnectTimeoutInSeconds) Sets the value of CfnFleetProps.getIdleDisconnectTimeoutInSeconds()
CfnFleetProps.Builder	imageArn(java.lang.String imageArn) Sets the value of CfnFleetProps.getImageArn()
CfnFleetProps.Builder	imageName(java.lang.String imageName) Sets the value of CfnFleetProps.getImageName()
CfnFleetProps.Builder	instanceType(java.lang.String instanceType) Sets the value of CfnFleetProps.getInstanceType()
CfnFleetProps.Builder	maxConcurrentSessions(java.lang.Number maxConcurrentSessions) Sets the value of CfnFleetProps.getMaxConcurrentSessions()
CfnFleetProps.Builder	maxUserDurationInSeconds(java.lang.Number maxUserDurationInSeconds) Sets the value of CfnFleetProps.getMaxUserDurationInSeconds()
CfnFleetProps.Builder	name(java.lang.String name) Sets the value of CfnFleetProps.getName()
CfnFleetProps.Builder	platform(java.lang.String platform) Sets the value of CfnFleetProps.getPlatform()
CfnFleetProps.Builder	sessionScriptS3Location(CfnFleet.S3LocationProperty sessionScriptS3Location) Sets the value of CfnFleetProps.getSessionScriptS3Location()
CfnFleetProps.Builder	sessionScriptS3Location(IResolvable sessionScriptS3Location) Sets the value of CfnFleetProps.getSessionScriptS3Location()
CfnFleetProps.Builder	streamView(java.lang.String streamView) Sets the value of CfnFleetProps.getStreamView()
CfnFleetProps.Builder	tags(java.util.List<? extends CfnTag> tags) Sets the value of CfnFleetProps.getTags()
CfnFleetProps.Builder	usbDeviceFilterStrings(java.util.List<java.lang.String> usbDeviceFilterStrings) Sets the value of CfnFleetProps.getUsbDeviceFilterStrings()
CfnFleetProps.Builder	vpcConfig(CfnFleet.VpcConfigProperty vpcConfig) Sets the value of CfnFleetProps.getVpcConfig()
CfnFleetProps.Builder	vpcConfig(IResolvable vpcConfig) Sets the value of CfnFleetProps.getVpcConfig()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

instanceType

public CfnFleetProps.Builder instanceType(java.lang.String instanceType)

Sets the value of CfnFleetProps.getInstanceType()

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.

• 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

Returns:

this

name

public CfnFleetProps.Builder name(java.lang.String name)

Sets the value of CfnFleetProps.getName()

Parameters:

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

Returns:

this

computeCapacity

public CfnFleetProps.Builder computeCapacity(IResolvable computeCapacity)

Sets the value of CfnFleetProps.getComputeCapacity()

Parameters:

computeCapacity - The desired capacity for the fleet. This is not allowed for Elastic fleets.

Returns:

this

computeCapacity

public CfnFleetProps.Builder computeCapacity(CfnFleet.ComputeCapacityProperty computeCapacity)

Sets the value of CfnFleetProps.getComputeCapacity()

Parameters:

computeCapacity - The desired capacity for the fleet. This is not allowed for Elastic fleets.

Returns:

this

description

public CfnFleetProps.Builder description(java.lang.String description)

Sets the value of CfnFleetProps.getDescription()

Parameters:

description - The description to display.

Returns:

this

disconnectTimeoutInSeconds

public CfnFleetProps.Builder disconnectTimeoutInSeconds(java.lang.Number disconnectTimeoutInSeconds)

Sets the value of CfnFleetProps.getDisconnectTimeoutInSeconds()

Parameters:

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:

this

displayName

public CfnFleetProps.Builder displayName(java.lang.String displayName)

Sets the value of CfnFleetProps.getDisplayName()

Parameters:

displayName - The fleet name to display.

Returns:

this

domainJoinInfo

public CfnFleetProps.Builder domainJoinInfo(IResolvable domainJoinInfo)

Sets the value of CfnFleetProps.getDomainJoinInfo()

Parameters:

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.

Returns:

this

domainJoinInfo

public CfnFleetProps.Builder domainJoinInfo(CfnFleet.DomainJoinInfoProperty domainJoinInfo)

Sets the value of CfnFleetProps.getDomainJoinInfo()

Parameters:

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.

Returns:

this

enableDefaultInternetAccess

public CfnFleetProps.Builder enableDefaultInternetAccess(java.lang.Boolean enableDefaultInternetAccess)

Sets the value of CfnFleetProps.getEnableDefaultInternetAccess()

Parameters:

enableDefaultInternetAccess - Enables or disables default internet access for the fleet.

Returns:

this

enableDefaultInternetAccess

public CfnFleetProps.Builder enableDefaultInternetAccess(IResolvable enableDefaultInternetAccess)

Sets the value of CfnFleetProps.getEnableDefaultInternetAccess()

Parameters:

enableDefaultInternetAccess - Enables or disables default internet access for the fleet.

Returns:

this

fleetType

public CfnFleetProps.Builder fleetType(java.lang.String fleetType)

Sets the value of CfnFleetProps.getFleetType()

Parameters:

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

Returns:

this

iamRoleArn

public CfnFleetProps.Builder iamRoleArn(java.lang.String iamRoleArn)

Sets the value of CfnFleetProps.getIamRoleArn()

Parameters:

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 .

Returns:

this

idleDisconnectTimeoutInSeconds

public CfnFleetProps.Builder idleDisconnectTimeoutInSeconds(java.lang.Number idleDisconnectTimeoutInSeconds)

Sets the value of CfnFleetProps.getIdleDisconnectTimeoutInSeconds()

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

Returns:

this

imageArn

public CfnFleetProps.Builder imageArn(java.lang.String imageArn)

Sets the value of CfnFleetProps.getImageArn()

Parameters:

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

Returns:

this

imageName

public CfnFleetProps.Builder imageName(java.lang.String imageName)

Sets the value of CfnFleetProps.getImageName()

Parameters:

imageName - The name of the image used to create the fleet.

Returns:

this

maxConcurrentSessions

public CfnFleetProps.Builder maxConcurrentSessions(java.lang.Number maxConcurrentSessions)

Sets the value of CfnFleetProps.getMaxConcurrentSessions()

Parameters:

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.

Returns:

this

maxUserDurationInSeconds

public CfnFleetProps.Builder maxUserDurationInSeconds(java.lang.Number maxUserDurationInSeconds)

Sets the value of CfnFleetProps.getMaxUserDurationInSeconds()

Parameters:

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:

this

platform

public CfnFleetProps.Builder platform(java.lang.String platform)

Sets the value of CfnFleetProps.getPlatform()

Parameters:

platform - The platform of the fleet. Platform is a required setting for Elastic fleets, and is not used for other fleet types.

Allowed Values : WINDOWS_SERVER_2019 | AMAZON_LINUX2

Returns:

this

sessionScriptS3Location

public CfnFleetProps.Builder sessionScriptS3Location(IResolvable sessionScriptS3Location)

Sets the value of CfnFleetProps.getSessionScriptS3Location()

Parameters:

sessionScriptS3Location - The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

Returns:

this

sessionScriptS3Location

public CfnFleetProps.Builder sessionScriptS3Location(CfnFleet.S3LocationProperty sessionScriptS3Location)

Sets the value of CfnFleetProps.getSessionScriptS3Location()

Parameters:

sessionScriptS3Location - The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

Returns:

this

streamView

public CfnFleetProps.Builder streamView(java.lang.String streamView)

Sets the value of CfnFleetProps.getStreamView()

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. The default value is APP .

Returns:

this

tags

public CfnFleetProps.Builder tags(java.util.List<? extends CfnTag> tags)

Sets the value of CfnFleetProps.getTags()

Parameters:

tags - An array of key-value pairs.

Returns:

this

usbDeviceFilterStrings

public CfnFleetProps.Builder usbDeviceFilterStrings(java.util.List<java.lang.String> usbDeviceFilterStrings)

Sets the value of CfnFleetProps.getUsbDeviceFilterStrings()

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 is allowed but not required for Elastic fleets.

Returns:

this

vpcConfig

public CfnFleetProps.Builder vpcConfig(IResolvable vpcConfig)

Sets the value of CfnFleetProps.getVpcConfig()

Parameters:

vpcConfig - The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types.

Returns:

this

vpcConfig

public CfnFleetProps.Builder vpcConfig(CfnFleet.VpcConfigProperty vpcConfig)

Sets the value of CfnFleetProps.getVpcConfig()

Parameters:

vpcConfig - The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types.

Returns:

this

build

public CfnFleetProps build()

Builds the configured instance.

Returns:

a new instance of CfnFleetProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided