Interface CfnFleetProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnFleetProps.Jsii$Proxy
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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnFleetProps
static final class
An implementation forCfnFleetProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnFleetProps.Builder
builder()
default Object
The desired capacity for the fleet.default String
The description to display.default Number
The amount of time that a streaming session remains active after users disconnect.default String
The fleet name to display.default Object
The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.default Object
Enables or disables default internet access for the fleet.default String
The fleet type.default String
The ARN of the IAM role that is applied to the fleet.default Number
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and theDisconnectTimeoutInSeconds
time interval begins.default String
The ARN of the public, private, or shared image to use.default String
The name of the image used to create the fleet.The instance type to use when launching fleet instances.default Number
The maximum number of concurrent sessions that can be run on an Elastic fleet.default Number
Max number of user sessions on an instance.default Number
The maximum amount of time that a streaming session can remain active, in seconds.getName()
A unique name for the fleet.default String
The platform of the fleet.default Object
The S3 location of the session scripts configuration zip file.default String
The AppStream 2.0 view that is displayed to your users when they stream from the fleet.getTags()
An array of key-value pairs.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
The VPC configuration for the fleet.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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:
-
getName
A unique name for the fleet.- See Also:
-
getComputeCapacity
The desired capacity for the fleet.This is not allowed for Elastic fleets.
- See Also:
-
getDescription
The description to display.- See Also:
-
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:
-
getDisplayName
The fleet name to display.- See Also:
-
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:
-
getEnableDefaultInternetAccess
Enables or disables default internet access for the fleet.- See Also:
-
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:
-
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:
-
getIdleDisconnectTimeoutInSeconds
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and theDisconnectTimeoutInSeconds
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 inIdleDisconnectTimeoutInSeconds
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:
-
getImageArn
The ARN of the public, private, or shared image to use.- See Also:
-
getImageName
The name of the image used to create the fleet.- See Also:
-
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:
-
getMaxSessionsPerInstance
Max number of user sessions on an instance.This is applicable only for multi-session fleets.
- See Also:
-
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:
-
getPlatform
The platform of the fleet.Platform is a required setting for Elastic fleets, and is not used for other fleet types.
- See Also:
-
getSessionScriptS3Location
The S3 location of the session scripts configuration zip file.This only applies to Elastic fleets.
- See Also:
-
getStreamView
The AppStream 2.0 view that is displayed to your users when they stream from the fleet. WhenAPP
is specified, only the windows of applications opened by users display. WhenDESKTOP
is specified, the standard desktop that is provided by the operating system displays.The default value is
APP
.- See Also:
-
getTags
An array of key-value pairs.- See Also:
-
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:
-
getVpcConfig
The VPC configuration for the fleet.This is required for Elastic fleets, but not required for other fleet types.
- See Also:
-
builder
- Returns:
- a
CfnFleetProps.Builder
ofCfnFleetProps
-