/AWS1/CL_APS=>CREATEFLEET()¶
About CreateFleet¶
Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_NAME TYPE /AWS1/APSNAME /AWS1/APSNAME¶
A unique name for the fleet.
IV_INSTANCETYPE TYPE /AWS1/APSSTRING /AWS1/APSSTRING¶
The instance type to use when launching fleet instances. The following instance types are available:
stream.standard.small
stream.standard.medium
stream.standard.large
stream.standard.xlarge
stream.standard.2xlarge
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.g5.xlarge
stream.graphics.g5.2xlarge
stream.graphics.g5.4xlarge
stream.graphics.g5.8xlarge
stream.graphics.g5.12xlarge
stream.graphics.g5.16xlarge
stream.graphics.g5.24xlarge
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
stream.standard.large
stream.standard.xlarge
stream.standard.2xlarge
Optional arguments:¶
IV_IMAGENAME TYPE /AWS1/APSNAME /AWS1/APSNAME¶
The name of the image used to create the fleet.
IV_IMAGEARN TYPE /AWS1/APSARN /AWS1/APSARN¶
The ARN of the public, private, or shared image to use.
IV_FLEETTYPE TYPE /AWS1/APSFLEETTYPE /AWS1/APSFLEETTYPE¶
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.
IO_COMPUTECAPACITY TYPE REF TO /AWS1/CL_APSCOMPUTECAPACITY /AWS1/CL_APSCOMPUTECAPACITY¶
The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.
IO_VPCCONFIG TYPE REF TO /AWS1/CL_APSVPCCONFIG /AWS1/CL_APSVPCCONFIG¶
The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.
IV_MAXUSERDURATIONINSECONDS TYPE /AWS1/APSINTEGER /AWS1/APSINTEGER¶
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.
IV_DISCNCTTIMEOUTINSECONDS TYPE /AWS1/APSINTEGER /AWS1/APSINTEGER¶
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.
IV_DESCRIPTION TYPE /AWS1/APSDESCRIPTION /AWS1/APSDESCRIPTION¶
The description to display.
IV_DISPLAYNAME TYPE /AWS1/APSDISPLAYNAME /AWS1/APSDISPLAYNAME¶
The fleet name to display.
IV_ENABLEDEFINTERNETACCESS TYPE /AWS1/APSBOOLEANOBJECT /AWS1/APSBOOLEANOBJECT¶
Enables or disables default internet access for the fleet.
IO_DOMAINJOININFO TYPE REF TO /AWS1/CL_APSDOMAINJOININFO /AWS1/CL_APSDOMAINJOININFO¶
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.
IT_TAGS TYPE /AWS1/CL_APSTAGS_W=>TT_TAGS TT_TAGS¶
The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
If you do not specify a value, the value is set to an empty string.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
_ . : / = + \ - @
For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
IV_IDLEDISCNCTTMOUTINSECONDS TYPE /AWS1/APSINTEGER /AWS1/APSINTEGER¶
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the
DisconnectTimeoutInSecondstime 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 inDisconnectTimeoutInSecondselapses, 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 inIdleDisconnectTimeoutInSecondselapses, 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. The default value is 0.
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.
IV_IAMROLEARN TYPE /AWS1/APSARN /AWS1/APSARN¶
The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS)
AssumeRoleAPI 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.
IV_STREAMVIEW TYPE /AWS1/APSSTREAMVIEW /AWS1/APSSTREAMVIEW¶
The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When
APPis specified, only the windows of applications opened by users display. WhenDESKTOPis specified, the standard desktop that is provided by the operating system displays.The default value is
APP.
IV_PLATFORM TYPE /AWS1/APSPLATFORMTYPE /AWS1/APSPLATFORMTYPE¶
The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
IV_MAXCONCURRENTSESSIONS TYPE /AWS1/APSINTEGER /AWS1/APSINTEGER¶
The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.
IT_USBDEVICEFILTERSTRINGS TYPE /AWS1/CL_APSUSBDEVFILTERSTRS_W=>TT_USBDEVICEFILTERSTRINGS TT_USBDEVICEFILTERSTRINGS¶
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.
IO_SESSIONSCRIPTS3LOCATION TYPE REF TO /AWS1/CL_APSS3LOCATION /AWS1/CL_APSS3LOCATION¶
The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
IV_MAXSESSIONSPERINSTANCE TYPE /AWS1/APSINTEGER /AWS1/APSINTEGER¶
The maximum number of user sessions on an instance. This only applies to multi-session fleets.