Class CfnFleet
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
AWS::AppStream::Fleet
.
The AWS::AppStream::Fleet
resource creates a fleet for Amazon AppStream 2.0. A fleet consists of streaming instances that run a specified image when using Always-On or On-Demand.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.appstream.*; CfnFleet cfnFleet = CfnFleet.Builder.create(this, "MyCfnFleet") .instanceType("instanceType") .name("name") // the properties below are optional .computeCapacity(ComputeCapacityProperty.builder() .desiredInstances(123) .build()) .description("description") .disconnectTimeoutInSeconds(123) .displayName("displayName") .domainJoinInfo(DomainJoinInfoProperty.builder() .directoryName("directoryName") .organizationalUnitDistinguishedName("organizationalUnitDistinguishedName") .build()) .enableDefaultInternetAccess(false) .fleetType("fleetType") .iamRoleArn("iamRoleArn") .idleDisconnectTimeoutInSeconds(123) .imageArn("imageArn") .imageName("imageName") .maxConcurrentSessions(123) .maxUserDurationInSeconds(123) .platform("platform") .sessionScriptS3Location(S3LocationProperty.builder() .s3Bucket("s3Bucket") .s3Key("s3Key") .build()) .streamView("streamView") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .usbDeviceFilterStrings(List.of("usbDeviceFilterStrings")) .vpcConfig(VpcConfigProperty.builder() .securityGroupIds(List.of("securityGroupIds")) .subnetIds(List.of("subnetIds")) .build()) .build();
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnFleet
.static interface
The desired capacity for a fleet.static interface
The name of the directory and organizational unit (OU) to use to join a fleet to a Microsoft Active Directory domain.static interface
Describes the S3 location.static interface
The VPC configuration information for the fleet.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe desired capacity for the fleet.The description to display.The amount of time that a streaming session remains active after users disconnect.The fleet name to display.The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.Enables or disables default internet access for the fleet.The fleet type.The ARN of the IAM role that is applied to the fleet.The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and theDisconnectTimeoutInSeconds
time interval begins.The ARN of the public, private, or shared image to use.The name of the image used to create the fleet.The instance type to use when launching fleet instances.The maximum number of concurrent sessions that can be run on an Elastic fleet.The maximum amount of time that a streaming session can remain active, in seconds.getName()
A unique name for the fleet.The platform of the fleet.The S3 location of the session scripts configuration zip file.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.The VPC configuration for the fleet.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setComputeCapacity
(IResolvable value) The desired capacity for the fleet.void
The desired capacity for the fleet.void
setDescription
(String value) The description to display.void
The amount of time that a streaming session remains active after users disconnect.void
setDisplayName
(String value) The fleet name to display.void
setDomainJoinInfo
(IResolvable value) The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.void
The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.void
Enables or disables default internet access for the fleet.void
Enables or disables default internet access for the fleet.void
setFleetType
(String value) The fleet type.void
setIamRoleArn
(String value) The ARN of the IAM role that is applied to the fleet.void
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and theDisconnectTimeoutInSeconds
time interval begins.void
setImageArn
(String value) The ARN of the public, private, or shared image to use.void
setImageName
(String value) The name of the image used to create the fleet.void
setInstanceType
(String value) The instance type to use when launching fleet instances.void
setMaxConcurrentSessions
(Number value) The maximum number of concurrent sessions that can be run on an Elastic fleet.void
The maximum amount of time that a streaming session can remain active, in seconds.void
A unique name for the fleet.void
setPlatform
(String value) The platform of the fleet.void
The S3 location of the session scripts configuration zip file.void
The S3 location of the session scripts configuration zip file.void
setStreamView
(String value) The AppStream 2.0 view that is displayed to your users when they stream from the fleet.void
setUsbDeviceFilterStrings
(List<String> value) 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.void
setVpcConfig
(IResolvable value) The VPC configuration for the fleet.void
The VPC configuration for the fleet.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnFleet
protected CfnFleet(software.amazon.jsii.JsiiObjectRef objRef) -
CfnFleet
protected CfnFleet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnFleet
@Stability(Stable) public CfnFleet(@NotNull Construct scope, @NotNull String id, @NotNull CfnFleetProps props) Create a newAWS::AppStream::Fleet
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
An array of key-value pairs. -
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
-
setInstanceType
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
-
getName
A unique name for the fleet. -
setName
A unique name for the fleet. -
getComputeCapacity
The desired capacity for the fleet.This is not allowed for Elastic fleets.
-
setComputeCapacity
The desired capacity for the fleet.This is not allowed for Elastic fleets.
-
setComputeCapacity
The desired capacity for the fleet.This is not allowed for Elastic fleets.
-
getDescription
The description to display. -
setDescription
The description to display. -
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 360000.
-
setDisconnectTimeoutInSeconds
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.
-
getDisplayName
The fleet name to display. -
setDisplayName
The fleet name to display. -
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.
-
setDomainJoinInfo
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.
-
setDomainJoinInfo
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.
-
getEnableDefaultInternetAccess
Enables or disables default internet access for the fleet. -
setEnableDefaultInternetAccess
Enables or disables default internet access for the fleet. -
setEnableDefaultInternetAccess
Enables or disables default internet access for the fleet. -
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
-
setFleetType
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
-
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 .
-
setIamRoleArn
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 .
-
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 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.
-
setIdleDisconnectTimeoutInSeconds
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 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.
-
getImageArn
The ARN of the public, private, or shared image to use. -
setImageArn
The ARN of the public, private, or shared image to use. -
getImageName
The name of the image used to create the fleet. -
setImageName
The name of the image used to create the fleet. -
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.
-
setMaxConcurrentSessions
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.
-
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 360000.
-
setMaxUserDurationInSeconds
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.
-
getPlatform
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
-
setPlatform
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
-
getSessionScriptS3Location
The S3 location of the session scripts configuration zip file.This only applies to Elastic fleets.
-
setSessionScriptS3Location
The S3 location of the session scripts configuration zip file.This only applies to Elastic fleets.
-
setSessionScriptS3Location
@Stability(Stable) public void setSessionScriptS3Location(@Nullable CfnFleet.S3LocationProperty value) The S3 location of the session scripts configuration zip file.This only applies to Elastic fleets.
-
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
. -
setStreamView
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
. -
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.
-
setUsbDeviceFilterStrings
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.
-
getVpcConfig
The VPC configuration for the fleet.This is required for Elastic fleets, but not required for other fleet types.
-
setVpcConfig
The VPC configuration for the fleet.This is required for Elastic fleets, but not required for other fleet types.
-
setVpcConfig
The VPC configuration for the fleet.This is required for Elastic fleets, but not required for other fleet types.
-