class Aws::AppStream::Types::CreateFleetRequest
@note When making an API call, you may pass CreateFleetRequest
data as a hash: { name: "Name", # required image_name: "String", image_arn: "Arn", instance_type: "String", # required fleet_type: "ALWAYS_ON", # accepts ALWAYS_ON, ON_DEMAND compute_capacity: { # required desired_instances: 1, # required }, vpc_config: { subnet_ids: ["String"], security_group_ids: ["String"], }, max_user_duration_in_seconds: 1, disconnect_timeout_in_seconds: 1, description: "Description", display_name: "DisplayName", enable_default_internet_access: false, domain_join_info: { directory_name: "DirectoryName", organizational_unit_distinguished_name: "OrganizationalUnitDistinguishedName", }, tags: { "TagKey" => "TagValue", }, idle_disconnect_timeout_in_seconds: 1, iam_role_arn: "Arn", stream_view: "APP", # accepts APP, DESKTOP }
@!attribute [rw] name
A unique name for the fleet. @return [String]
@!attribute [rw] image_name
The name of the image used to create the fleet. @return [String]
@!attribute [rw] image_arn
The ARN of the public, private, or shared image to use. @return [String]
@!attribute [rw] instance_type
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.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 @return [String]
@!attribute [rw] fleet_type
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. @return [String]
@!attribute [rw] compute_capacity
The desired capacity for the fleet. @return [Types::ComputeCapacity]
@!attribute [rw] vpc_config
The VPC configuration for the fleet. @return [Types::VpcConfig]
@!attribute [rw] max_user_duration_in_seconds
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. @return [Integer]
@!attribute [rw] disconnect_timeout_in_seconds
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. @return [Integer]
@!attribute [rw] description
The description to display. @return [String]
@!attribute [rw] display_name
The fleet name to display. @return [String]
@!attribute [rw] enable_default_internet_access
Enables or disables default internet access for the fleet. @return [Boolean]
@!attribute [rw] domain_join_info
The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. @return [Types::DomainJoinInfo]
@!attribute [rw] 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][1] in the *Amazon AppStream 2.0 Administration Guide*. [1]: https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html @return [Hash<String,String>]
@!attribute [rw] idle_disconnect_timeout_in_seconds
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. The default value is 0. <note markdown="1"> 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. </note> @return [Integer]
@!attribute [rw] iam_role_arn
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) `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][1] in the *Amazon AppStream 2.0 Administration Guide*. [1]: https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html @return [String]
@!attribute [rw] stream_view
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`. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateFleetRequest AWS API Documentation
Constants
- SENSITIVE