You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::AppStream::Types::CreateFleetRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb

Overview

Note:

When making an API call, you may pass CreateFleetRequest data as a hash:

{
  name: "Name", # required
  image_name: "String", # required
  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",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#compute_capacityTypes::ComputeCapacity

The desired capacity for the fleet.



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 300

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity,
  :vpc_config,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :description,
  :display_name,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#descriptionString

The description displayed to end users.

Returns:

  • (String)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 300

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity,
  :vpc_config,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :description,
  :display_name,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#disconnect_timeout_in_secondsInteger

The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.

Returns:

  • (Integer)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 300

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity,
  :vpc_config,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :description,
  :display_name,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#display_nameString

The fleet name displayed to end users.

Returns:

  • (String)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 300

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity,
  :vpc_config,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :description,
  :display_name,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#domain_join_infoTypes::DomainJoinInfo

The information needed for streaming instances to join a domain.



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 300

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity,
  :vpc_config,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :description,
  :display_name,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#enable_default_internet_accessBoolean

Enables or disables default internet access for the fleet.

Returns:

  • (Boolean)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 300

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity,
  :vpc_config,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :description,
  :display_name,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#fleet_typeString

Returns:

  • (String)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 300

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity,
  :vpc_config,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :description,
  :display_name,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#image_nameString

The name of the image used by the fleet.

Returns:

  • (String)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 300

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity,
  :vpc_config,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :description,
  :display_name,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#instance_typeString

The instance type to use when launching fleet instances. The following instance types are available:

  • 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.graphics-design.large

  • stream.graphics-design.xlarge

  • stream.graphics-design.2xlarge

  • stream.graphics-design.4xlarge

  • stream.graphics-desktop.2xlarge

  • stream.graphics-pro.4xlarge

  • stream.graphics-pro.8xlarge

  • stream.graphics-pro.16xlarge

Returns:

  • (String)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 300

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity,
  :vpc_config,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :description,
  :display_name,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#max_user_duration_in_secondsInteger

The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.

Returns:

  • (Integer)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 300

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity,
  :vpc_config,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :description,
  :display_name,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#nameString

A unique name for the fleet.

Returns:

  • (String)


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 300

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity,
  :vpc_config,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :description,
  :display_name,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end

#vpc_configTypes::VpcConfig

The VPC configuration for the fleet.

Returns:



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 300

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_type,
  :fleet_type,
  :compute_capacity,
  :vpc_config,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :description,
  :display_name,
  :enable_default_internet_access,
  :domain_join_info)
  include Aws::Structure
end