Package software.amazon.awscdk.services.appstream

Interface CfnFleetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFleetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:25.664Z")
@Stability(Stable)
public interface CfnFleetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnFleet.

Example:

 CfnFleet fleet = CfnFleet.Builder.create(this, "Fleet")
         .instanceType("stream.standard.small")
         .name("Fleet")
         .computeCapacity(ComputeCapacityProperty.builder()
                 .desiredInstances(1)
                 .build())
         .imageName("AppStream-AmazonLinux2-09-21-2022")
         .build();
 fleet.getCfnOptions().getCreationPolicy() = CfnCreationPolicy.builder()
         .startFleet(true)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFleetProps.Builder	A builder for CfnFleetProps
static final class	CfnFleetProps.Jsii$Proxy	An implementation for CfnFleetProps

Method Summary

Modifier and Type	Method	Description
static CfnFleetProps.Builder	builder()
default Object	getComputeCapacity()	The desired capacity for the fleet.
default String	getDescription()	The description to display.
default Number	getDisconnectTimeoutInSeconds()	The amount of time that a streaming session remains active after users disconnect.
default String	getDisplayName()	The fleet name to display.
default Object	getDomainJoinInfo()	The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
default Object	getEnableDefaultInternetAccess()	Enables or disables default internet access for the fleet.
default String	getFleetType()	The fleet type.
default String	getIamRoleArn()	The ARN of the IAM role that is applied to the fleet.
default Number	getIdleDisconnectTimeoutInSeconds()	The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins.
default String	getImageArn()	The ARN of the public, private, or shared image to use.
default String	getImageName()	The name of the image used to create the fleet.
String	getInstanceType()	The instance type to use when launching fleet instances.
default Number	getMaxConcurrentSessions()	The maximum number of concurrent sessions that can be run on an Elastic fleet.
default Number	getMaxSessionsPerInstance()	Max number of user sessions on an instance.
default Number	getMaxUserDurationInSeconds()	The maximum amount of time that a streaming session can remain active, in seconds.
String	getName()	A unique name for the fleet.
default String	getPlatform()	The platform of the fleet.
default Object	getSessionScriptS3Location()	The S3 location of the session scripts configuration zip file.
default String	getStreamView()	The AppStream 2.0 view that is displayed to your users when they stream from the fleet.
default List<CfnTag>	getTags()	An array of key-value pairs.
default List<String>	getUsbDeviceFilterStrings()	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 Object	getVpcConfig()	The VPC configuration for the fleet.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInstanceType

@Stability(Stable)
@NotNull
String getInstanceType()

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

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

A unique name for the fleet.

See Also:

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

getComputeCapacity

@Stability(Stable)
@Nullable
default Object getComputeCapacity()

The desired capacity for the fleet.

This is not allowed for Elastic fleets.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description to display.

See Also:

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

getDisconnectTimeoutInSeconds

@Stability(Stable)
@Nullable
default Number getDisconnectTimeoutInSeconds()

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.

See Also:

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

getDisplayName

@Stability(Stable)
@Nullable
default String getDisplayName()

The fleet name to display.

See Also:

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

getDomainJoinInfo

@Stability(Stable)
@Nullable
default Object getDomainJoinInfo()

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.

See Also:

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

getEnableDefaultInternetAccess

@Stability(Stable)
@Nullable
default Object getEnableDefaultInternetAccess()

Enables or disables default internet access for the fleet.

See Also:

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

getFleetType

@Stability(Stable)
@Nullable
default String getFleetType()

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

See Also:

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

getIamRoleArn

@Stability(Stable)
@Nullable
default String getIamRoleArn()

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 .

See Also:

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

getIdleDisconnectTimeoutInSeconds

@Stability(Stable)
@Nullable
default Number getIdleDisconnectTimeoutInSeconds()

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.

See Also:

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

getImageArn

@Stability(Stable)
@Nullable
default String getImageArn()

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

See Also:

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

getImageName

@Stability(Stable)
@Nullable
default String getImageName()

The name of the image used to create the fleet.

See Also:

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

getMaxConcurrentSessions

@Stability(Stable)
@Nullable
default Number getMaxConcurrentSessions()

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.

See Also:

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

getMaxSessionsPerInstance

@Stability(Stable)
@Nullable
default Number getMaxSessionsPerInstance()

Max number of user sessions on an instance.

This is applicable only for multi-session fleets.

See Also:

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

getMaxUserDurationInSeconds

@Stability(Stable)
@Nullable
default Number getMaxUserDurationInSeconds()

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.

See Also:

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

getPlatform

@Stability(Stable)
@Nullable
default String getPlatform()

The platform of the fleet.

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

See Also:

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

getSessionScriptS3Location

@Stability(Stable)
@Nullable
default Object getSessionScriptS3Location()

The S3 location of the session scripts configuration zip file.

This only applies to Elastic fleets.

See Also:

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

getStreamView

@Stability(Stable)
@Nullable
default String getStreamView()

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 .

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs.

See Also:

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

getUsbDeviceFilterStrings

@Stability(Stable)
@Nullable
default List<String> getUsbDeviceFilterStrings()

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.

See Also:

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

getVpcConfig

@Stability(Stable)
@Nullable
default Object getVpcConfig()

The VPC configuration for the fleet.

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

See Also:

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

builder

@Stability(Stable)
static CfnFleetProps.Builder builder()

Returns:

a CfnFleetProps.Builder of CfnFleetProps