@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
date="2022-05-20T22:19:53.449Z")
public interface CfnFleetProps
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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnFleetProps.Builder
A builder for
CfnFleetProps |
static class |
CfnFleetProps.Jsii$Proxy
An implementation for
CfnFleetProps |
Modifier and Type | Method and Description |
---|---|
static CfnFleetProps.Builder |
builder() |
default java.lang.Object |
getComputeCapacity()
The desired capacity for the fleet.
|
default java.lang.String |
getDescription()
The description to display.
|
default java.lang.Number |
getDisconnectTimeoutInSeconds()
The amount of time that a streaming session remains active after users disconnect.
|
default java.lang.String |
getDisplayName()
The fleet name to display.
|
default java.lang.Object |
getDomainJoinInfo()
The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
|
default java.lang.Object |
getEnableDefaultInternetAccess()
Enables or disables default internet access for the fleet.
|
default java.lang.String |
getFleetType()
The fleet type.
|
default java.lang.String |
getIamRoleArn()
The ARN of the IAM role that is applied to the fleet.
|
default java.lang.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 java.lang.String |
getImageArn()
The ARN of the public, private, or shared image to use.
|
default java.lang.String |
getImageName()
The name of the image used to create the fleet.
|
java.lang.String |
getInstanceType()
The instance type to use when launching fleet instances.
|
default java.lang.Number |
getMaxConcurrentSessions()
The maximum number of concurrent sessions that can be run on an Elastic fleet.
|
default java.lang.Number |
getMaxUserDurationInSeconds()
The maximum amount of time that a streaming session can remain active, in seconds.
|
java.lang.String |
getName()
A unique name for the fleet.
|
default java.lang.String |
getPlatform()
The platform of the fleet.
|
default java.lang.Object |
getSessionScriptS3Location()
The S3 location of the session scripts configuration zip file.
|
default java.lang.String |
getStreamView()
The AppStream 2.0 view that is displayed to your users when they stream from the fleet.
|
default java.util.List<CfnTag> |
getTags()
An array of key-value pairs.
|
default java.util.List<java.lang.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 java.lang.Object |
getVpcConfig()
The VPC configuration for the fleet.
|
java.lang.String getInstanceType()
The following instance types are available for Elastic fleets:
java.lang.String getName()
default java.lang.Object getComputeCapacity()
This is not allowed for Elastic fleets.
default java.lang.String getDescription()
default java.lang.Number getDisconnectTimeoutInSeconds()
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.
default java.lang.String getDisplayName()
default java.lang.Object getDomainJoinInfo()
This is not allowed for Elastic fleets.
default java.lang.Object getEnableDefaultInternetAccess()
default java.lang.String getFleetType()
Allowed Values : ALWAYS_ON
| ELASTIC
| ON_DEMAND
default java.lang.String getIamRoleArn()
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 .
default java.lang.Number getIdleDisconnectTimeoutInSeconds()
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.
default java.lang.String getImageArn()
default java.lang.String getImageName()
default java.lang.Number getMaxConcurrentSessions()
This setting is required for Elastic fleets, but is not used for other fleet types.
default java.lang.Number getMaxUserDurationInSeconds()
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.
default java.lang.String getPlatform()
Platform is a required setting for Elastic fleets, and is not used for other fleet types.
Allowed Values : WINDOWS_SERVER_2019
| AMAZON_LINUX2
default java.lang.Object getSessionScriptS3Location()
This only applies to Elastic fleets.
default java.lang.String getStreamView()
The default value is APP
.
default java.util.List<CfnTag> getTags()
default java.util.List<java.lang.String> getUsbDeviceFilterStrings()
This is allowed but not required for Elastic fleets.
default java.lang.Object getVpcConfig()
This is required for Elastic fleets, but not required for other fleet types.
static CfnFleetProps.Builder builder()
CfnFleetProps.Builder
of CfnFleetProps