CfnFleet (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.CfnElement
    - - software.amazon.awscdk.CfnRefElement
      - software.amazon.awscdk.CfnResource
        
        software.amazon.awscdk.services.appstream.CfnFleet

All Implemented Interfaces:: IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.627Z")
 @Stability(value=Stable)
public class CfnFleet
extends CfnResource
implements IInspectable

A CloudFormation `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

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnFleet.Builder` A fluent builder for `CfnFleet`.
`static interface`	`CfnFleet.ComputeCapacityProperty` The desired capacity for a fleet.
`static interface`	`CfnFleet.DomainJoinInfoProperty` The name of the directory and organizational unit (OU) to use to join a fleet to a Microsoft Active Directory domain.
`static interface`	`CfnFleet.S3LocationProperty` Describes the S3 location.
`static interface`	`CfnFleet.VpcConfigProperty` 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.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnFleet(software.constructs.Construct scope, String id, CfnFleetProps props)` Create a new `AWS::AppStream::Fleet`.
`protected`	`CfnFleet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnFleet(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Map<String,Object>`	`getCfnProperties()`
`Object`	`getComputeCapacity()` The desired capacity for the fleet.
`String`	`getDescription()` The description to display.
`Number`	`getDisconnectTimeoutInSeconds()` The amount of time that a streaming session remains active after users disconnect.
`String`	`getDisplayName()` The fleet name to display.
`Object`	`getDomainJoinInfo()` The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
`Object`	`getEnableDefaultInternetAccess()` Enables or disables default internet access for the fleet.
`String`	`getFleetType()` The fleet type.
`String`	`getIamRoleArn()` The ARN of the IAM role that is applied to the fleet.
`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.
`String`	`getImageArn()` The ARN of the public, private, or shared image to use.
`String`	`getImageName()` The name of the image used to create the fleet.
`String`	`getInstanceType()` The instance type to use when launching fleet instances.
`Number`	`getMaxConcurrentSessions()` The maximum number of concurrent sessions that can be run on an Elastic fleet.
`Number`	`getMaxUserDurationInSeconds()` The maximum amount of time that a streaming session can remain active, in seconds.
`String`	`getName()` A unique name for the fleet.
`String`	`getPlatform()` The platform of the fleet.
`Object`	`getSessionScriptS3Location()` The S3 location of the session scripts configuration zip file.
`String`	`getStreamView()` The AppStream 2.0 view that is displayed to your users when they stream from the fleet.
`TagManager`	`getTags()` An array of key-value pairs.
`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.
`Object`	`getVpcConfig()` The VPC configuration for the fleet.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setComputeCapacity(CfnFleet.ComputeCapacityProperty value)` The desired capacity for the fleet.
`void`	`setComputeCapacity(IResolvable value)` The desired capacity for the fleet.
`void`	`setDescription(String value)` The description to display.
`void`	`setDisconnectTimeoutInSeconds(Number value)` The amount of time that a streaming session remains active after users disconnect.
`void`	`setDisplayName(String value)` The fleet name to display.
`void`	`setDomainJoinInfo(CfnFleet.DomainJoinInfoProperty value)` The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
`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`	`setEnableDefaultInternetAccess(Boolean value)` Enables or disables default internet access for the fleet.
`void`	`setEnableDefaultInternetAccess(IResolvable value)` 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`	`setIdleDisconnectTimeoutInSeconds(Number value)` The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the `DisconnectTimeoutInSeconds` 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`	`setMaxUserDurationInSeconds(Number value)` The maximum amount of time that a streaming session can remain active, in seconds.
`void`	`setName(String value)` A unique name for the fleet.
`void`	`setPlatform(String value)` The platform of the fleet.
`void`	`setSessionScriptS3Location(CfnFleet.S3LocationProperty value)` The S3 location of the session scripts configuration zip file.
`void`	`setSessionScriptS3Location(IResolvable value)` 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(CfnFleet.VpcConfigProperty value)` The VPC configuration for the fleet.
`void`	`setVpcConfig(IResolvable value)` The VPC configuration for the fleet.

Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct
getNode, isConstruct

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 Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnFleet
```
protected CfnFleet(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnFleet
```
protected CfnFleet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnFleet
```
@Stability(value=Stable)
public CfnFleet(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         CfnFleetProps props)
```
    Create a new `AWS::AppStream::Fleet`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=Stable)
 @NotNull
public TagManager getTags()
```
    An array of key-value pairs.
  - getInstanceType
```
@Stability(value=Stable)
 @NotNull
public 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
  - setInstanceType
```
@Stability(value=Stable)
public void setInstanceType(@NotNull
                                                     String value)
```
    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
```
@Stability(value=Stable)
 @NotNull
public String getName()
```
    A unique name for the fleet.
  - setName
```
@Stability(value=Stable)
public void setName(@NotNull
                                             String value)
```
    A unique name for the fleet.
  - getComputeCapacity
```
@Stability(value=Stable)
 @Nullable
public Object getComputeCapacity()
```
    The desired capacity for the fleet.
    This is not allowed for Elastic fleets.
  - setComputeCapacity
```
@Stability(value=Stable)
public void setComputeCapacity(@Nullable
                                                        CfnFleet.ComputeCapacityProperty value)
```
    The desired capacity for the fleet.
    This is not allowed for Elastic fleets.
  - setComputeCapacity
```
@Stability(value=Stable)
public void setComputeCapacity(@Nullable
                                                        IResolvable value)
```
    The desired capacity for the fleet.
    This is not allowed for Elastic fleets.
  - getDescription
```
@Stability(value=Stable)
 @Nullable
public String getDescription()
```
    The description to display.
  - setDescription
```
@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)
```
    The description to display.
  - getDisconnectTimeoutInSeconds
```
@Stability(value=Stable)
 @Nullable
public 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 360000.
  - setDisconnectTimeoutInSeconds
```
@Stability(value=Stable)
public void setDisconnectTimeoutInSeconds(@Nullable
                                                                   Number value)
```
    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
```
@Stability(value=Stable)
 @Nullable
public String getDisplayName()
```
    The fleet name to display.
  - setDisplayName
```
@Stability(value=Stable)
public void setDisplayName(@Nullable
                                                    String value)
```
    The fleet name to display.
  - getDomainJoinInfo
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setDomainJoinInfo
```
@Stability(value=Stable)
public void setDomainJoinInfo(@Nullable
                                                       CfnFleet.DomainJoinInfoProperty value)
```
    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
```
@Stability(value=Stable)
public void setDomainJoinInfo(@Nullable
                                                       IResolvable value)
```
    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
```
@Stability(value=Stable)
 @Nullable
public Object getEnableDefaultInternetAccess()
```
    Enables or disables default internet access for the fleet.
  - setEnableDefaultInternetAccess
```
@Stability(value=Stable)
public void setEnableDefaultInternetAccess(@Nullable
                                                                    Boolean value)
```
    Enables or disables default internet access for the fleet.
  - setEnableDefaultInternetAccess
```
@Stability(value=Stable)
public void setEnableDefaultInternetAccess(@Nullable
                                                                    IResolvable value)
```
    Enables or disables default internet access for the fleet.
  - getFleetType
```
@Stability(value=Stable)
 @Nullable
public 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
  - setFleetType
```
@Stability(value=Stable)
public void setFleetType(@Nullable
                                                  String value)
```
    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
```
@Stability(value=Stable)
 @Nullable
public 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 .
  - setIamRoleArn
```
@Stability(value=Stable)
public void setIamRoleArn(@Nullable
                                                   String value)
```
    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
```
@Stability(value=Stable)
 @Nullable
public 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 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
```
@Stability(value=Stable)
public void setIdleDisconnectTimeoutInSeconds(@Nullable
                                                                       Number value)
```
    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.
  - getImageArn
```
@Stability(value=Stable)
 @Nullable
public String getImageArn()
```
    The ARN of the public, private, or shared image to use.
  - setImageArn
```
@Stability(value=Stable)
public void setImageArn(@Nullable
                                                 String value)
```
    The ARN of the public, private, or shared image to use.
  - getImageName
```
@Stability(value=Stable)
 @Nullable
public String getImageName()
```
    The name of the image used to create the fleet.
  - setImageName
```
@Stability(value=Stable)
public void setImageName(@Nullable
                                                  String value)
```
    The name of the image used to create the fleet.
  - getMaxConcurrentSessions
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setMaxConcurrentSessions
```
@Stability(value=Stable)
public void setMaxConcurrentSessions(@Nullable
                                                              Number value)
```
    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
```
@Stability(value=Stable)
 @Nullable
public 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 360000.
  - setMaxUserDurationInSeconds
```
@Stability(value=Stable)
public void setMaxUserDurationInSeconds(@Nullable
                                                                 Number value)
```
    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
```
@Stability(value=Stable)
 @Nullable
public String 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
```
@Stability(value=Stable)
public void setPlatform(@Nullable
                                                 String value)
```
    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
```
@Stability(value=Stable)
 @Nullable
public Object getSessionScriptS3Location()
```
    The S3 location of the session scripts configuration zip file.
    This only applies to Elastic fleets.
  - setSessionScriptS3Location
```
@Stability(value=Stable)
public void setSessionScriptS3Location(@Nullable
                                                                CfnFleet.S3LocationProperty value)
```
    The S3 location of the session scripts configuration zip file.
    This only applies to Elastic fleets.
  - setSessionScriptS3Location
```
@Stability(value=Stable)
public void setSessionScriptS3Location(@Nullable
                                                                IResolvable value)
```
    The S3 location of the session scripts configuration zip file.
    This only applies to Elastic fleets.
  - getStreamView
```
@Stability(value=Stable)
 @Nullable
public 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 .
  - setStreamView
```
@Stability(value=Stable)
public void setStreamView(@Nullable
                                                   String value)
```
    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 .
  - getUsbDeviceFilterStrings
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setUsbDeviceFilterStrings
```
@Stability(value=Stable)
public void setUsbDeviceFilterStrings(@Nullable
                                                               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.
    This is allowed but not required for Elastic fleets.
  - getVpcConfig
```
@Stability(value=Stable)
 @Nullable
public Object getVpcConfig()
```
    The VPC configuration for the fleet.
    This is required for Elastic fleets, but not required for other fleet types.
  - setVpcConfig
```
@Stability(value=Stable)
public void setVpcConfig(@Nullable
                                                  CfnFleet.VpcConfigProperty value)
```
    The VPC configuration for the fleet.
    This is required for Elastic fleets, but not required for other fleet types.
  - setVpcConfig
```
@Stability(value=Stable)
public void setVpcConfig(@Nullable
                                                  IResolvable value)
```
    The VPC configuration for the fleet.
    This is required for Elastic fleets, but not required for other fleet types.

Class CfnFleet

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

Nested classes/interfaces inherited from interface software.constructs.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnFleet

CfnFleet

CfnFleet

Method Detail

inspect

renderProperties

getCfnProperties

getTags

getInstanceType

setInstanceType

getName

setName

getComputeCapacity

setComputeCapacity

setComputeCapacity

getDescription

setDescription

getDisconnectTimeoutInSeconds

setDisconnectTimeoutInSeconds

getDisplayName

setDisplayName

getDomainJoinInfo

setDomainJoinInfo

setDomainJoinInfo

getEnableDefaultInternetAccess

setEnableDefaultInternetAccess

setEnableDefaultInternetAccess

getFleetType

setFleetType

getIamRoleArn

setIamRoleArn

getIdleDisconnectTimeoutInSeconds

setIdleDisconnectTimeoutInSeconds

getImageArn

setImageArn

getImageName

setImageName

getMaxConcurrentSessions

setMaxConcurrentSessions

getMaxUserDurationInSeconds

setMaxUserDurationInSeconds

getPlatform

setPlatform

getSessionScriptS3Location

setSessionScriptS3Location

setSessionScriptS3Location

getStreamView

setStreamView

getUsbDeviceFilterStrings

setUsbDeviceFilterStrings

getVpcConfig

setVpcConfig

setVpcConfig