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
  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",
  },
}

Contains the parameters for the new fleet to create.

Instance Attribute Summary collapse

Instance Attribute Details

#compute_capacityTypes::ComputeCapacity

The parameters for the capacity allocated to the fleet.



285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 285

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_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 of the fleet.

Returns:

  • (String)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 285

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_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. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds between 60 and 57600.

Returns:

  • (Integer)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 285

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_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 display name of the fleet.

Returns:

  • (String)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 285

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_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 DirectoryName and OrganizationalUnitDistinguishedName values, which are used to join domains for the AppStream 2.0 streaming instances.



285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 285

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_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)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 285

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_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

Unique name of the image used by the fleet.

Returns:

  • (String)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 285

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_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 of compute resources for the fleet. Fleet instances are launched from this instance type. Available instance types are:

  • 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

Returns:

  • (String)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 285

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_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 for which a streaming session can run. The input can be any numeric value in seconds between 600 and 57600.

Returns:

  • (Integer)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 285

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_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 identifier for the fleet.

Returns:

  • (String)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 285

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_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:



285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 285

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :instance_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