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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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",
  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",
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#compute_capacity ⇒ Types::ComputeCapacity

The desired capacity for the fleet.

Returns:



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/aws-sdk-appstream/types.rb', line 519

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :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,
  :tags)
  include Aws::Structure
end

#description ⇒ String

The description to display.

Returns:

  • (String) 


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/aws-sdk-appstream/types.rb', line 519

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :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,
  :tags)
  include Aws::Structure
end

#disconnect_timeout_in_seconds ⇒ Integer

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 360000.

Returns:

  • (Integer) 


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/aws-sdk-appstream/types.rb', line 519

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :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,
  :tags)
  include Aws::Structure
end

#display_name ⇒ String

The fleet name to display.

Returns:

  • (String) 


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/aws-sdk-appstream/types.rb', line 519

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :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,
  :tags)
  include Aws::Structure
end

#domain_join_info ⇒ Types::DomainJoinInfo

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

Returns:



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/aws-sdk-appstream/types.rb', line 519

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :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,
  :tags)
  include Aws::Structure
end

#enable_default_internet_access ⇒ Boolean

Enables or disables default internet access for the fleet.

Returns:

  • (Boolean) 


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/aws-sdk-appstream/types.rb', line 519

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :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,
  :tags)
  include Aws::Structure
end

#fleet_type ⇒ String

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.

Returns:

  • (String) 


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/aws-sdk-appstream/types.rb', line 519

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :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,
  :tags)
  include Aws::Structure
end

#image_arn ⇒ String

The ARN of the public, private, or shared image to use.

Returns:

  • (String) 


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/aws-sdk-appstream/types.rb', line 519

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :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,
  :tags)
  include Aws::Structure
end

#image_name ⇒ String

The name of the image used to create the fleet.

Returns:

  • (String) 


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/aws-sdk-appstream/types.rb', line 519

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :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,
  :tags)
  include Aws::Structure
end

#instance_type ⇒ String

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) 


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/aws-sdk-appstream/types.rb', line 519

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :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,
  :tags)
  include Aws::Structure
end

#max_user_duration_in_seconds ⇒ Integer

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

Returns:

  • (Integer) 


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/aws-sdk-appstream/types.rb', line 519

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :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,
  :tags)
  include Aws::Structure
end

#name ⇒ String

A unique name for the fleet.

Returns:

  • (String) 


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/aws-sdk-appstream/types.rb', line 519

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :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,
  :tags)
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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.

For more information, see [Tagging Your Resources] in the *Amazon AppStream 2.0 Developer Guide*.

[1]: docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html

Returns:

  • (Hash<String,String>) 


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/aws-sdk-appstream/types.rb', line 519

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :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,
  :tags)
  include Aws::Structure
end

#vpc_config ⇒ Types::VpcConfig

The VPC configuration for the fleet.

Returns:



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/aws-sdk-appstream/types.rb', line 519

class CreateFleetRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :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,
  :tags)
  include Aws::Structure
end