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

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnFleetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.631Z")
 @Stability(value=Stable)
public interface CfnFleetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnFleet`.

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.*;
 CfnFleetProps cfnFleetProps = CfnFleetProps.builder()
         .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	Interface and Description
`static class`	`CfnFleetProps.Builder` A builder for `CfnFleetProps`
`static class`	`CfnFleetProps.Jsii$Proxy` An implementation for `CfnFleetProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and 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`	`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 Detail
  - getInstanceType
```
@Stability(value=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
  - getName
```
@Stability(value=Stable)
 @NotNull
String getName()
```
    A unique name for the fleet.
  - getComputeCapacity
```
@Stability(value=Stable)
 @Nullable
default Object getComputeCapacity()
```
    The desired capacity for the fleet.
    This is not allowed for Elastic fleets.
  - getDescription
```
@Stability(value=Stable)
 @Nullable
default String getDescription()
```
    The description to display.
  - getDisconnectTimeoutInSeconds
```
@Stability(value=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 360000.
  - getDisplayName
```
@Stability(value=Stable)
 @Nullable
default String getDisplayName()
```
    The fleet name to display.
  - getDomainJoinInfo
```
@Stability(value=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.
  - getEnableDefaultInternetAccess
```
@Stability(value=Stable)
 @Nullable
default Object getEnableDefaultInternetAccess()
```
    Enables or disables default internet access for the fleet.
  - getFleetType
```
@Stability(value=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
  - getIamRoleArn
```
@Stability(value=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 .
  - getIdleDisconnectTimeoutInSeconds
```
@Stability(value=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 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
default String getImageArn()
```
    The ARN of the public, private, or shared image to use.
  - getImageName
```
@Stability(value=Stable)
 @Nullable
default String getImageName()
```
    The name of the image used to create the fleet.
  - getMaxConcurrentSessions
```
@Stability(value=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.
  - getMaxUserDurationInSeconds
```
@Stability(value=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 360000.
  - getPlatform
```
@Stability(value=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.
    Allowed Values : WINDOWS_SERVER_2019 | AMAZON_LINUX2
  - getSessionScriptS3Location
```
@Stability(value=Stable)
 @Nullable
default Object getSessionScriptS3Location()
```
    The S3 location of the session scripts configuration zip file.
    This only applies to Elastic fleets.
  - getStreamView
```
@Stability(value=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 .
  - getTags
```
@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()
```
    An array of key-value pairs.
  - getUsbDeviceFilterStrings
```
@Stability(value=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.
  - getVpcConfig
```
@Stability(value=Stable)
 @Nullable
default Object getVpcConfig()
```
    The VPC configuration for the fleet.
    This is required for Elastic fleets, but not required for other fleet types.
  - builder
```
@Stability(value=Stable)
static CfnFleetProps.Builder builder()
```
    Returns:
    
    a CfnFleetProps.Builder of CfnFleetProps

Interface CfnFleetProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getInstanceType

getName

getComputeCapacity

getDescription

getDisconnectTimeoutInSeconds

getDisplayName

getDomainJoinInfo

getEnableDefaultInternetAccess

getFleetType

getIamRoleArn

getIdleDisconnectTimeoutInSeconds

getImageArn

getImageName

getMaxConcurrentSessions

getMaxUserDurationInSeconds

getPlatform

getSessionScriptS3Location

getStreamView

getTags

getUsbDeviceFilterStrings

getVpcConfig

builder