Class: Aws::AppStream::Types::UpdateFleetRequest

Inherits:

Struct

• Object
• Struct
• Aws::AppStream::Types::UpdateFleetRequest

Includes:

Structure

Defined in:

lib/aws-sdk-appstream/types.rb

Overview

Note:

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

{
  image_name: "String",
  image_arn: "Arn",
  name: "String",
  instance_type: "String",
  compute_capacity: {
    desired_instances: 1, # required
  },
  vpc_config: {
    subnet_ids: ["String"],
    security_group_ids: ["String"],
  },
  max_user_duration_in_seconds: 1,
  disconnect_timeout_in_seconds: 1,
  delete_vpc_config: false,
  description: "Description",
  display_name: "DisplayName",
  enable_default_internet_access: false,
  domain_join_info: {
    directory_name: "DirectoryName",
    organizational_unit_distinguished_name: "OrganizationalUnitDistinguishedName",
  },
  attributes_to_delete: ["VPC_CONFIGURATION"], # accepts VPC_CONFIGURATION, VPC_CONFIGURATION_SECURITY_GROUP_IDS, DOMAIN_JOIN_INFO
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #attributes_to_delete ⇒ Array<String>

  The fleet attributes to delete.

• #compute_capacity ⇒ Types::ComputeCapacity

  The desired capacity for the fleet.

• #delete_vpc_config ⇒ Boolean

  Deletes the VPC association for the specified fleet.

• #description ⇒ String

  The description to display.

• #disconnect_timeout_in_seconds ⇒ Integer

  The time after disconnection when a session is considered to have ended, in seconds.

• #display_name ⇒ String

  The fleet name to display.

• #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.

• #enable_default_internet_access ⇒ Boolean

  Enables or disables default internet access for the fleet.

• #image_arn ⇒ String

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

• #image_name ⇒ String

  The name of the image used to create the fleet.

• #instance_type ⇒ String

  The instance type to use when launching fleet instances.

• #max_user_duration_in_seconds ⇒ Integer

  The maximum time that a streaming session can run, in seconds.

• #name ⇒ String

  A unique name for the fleet.

• #vpc_config ⇒ Types::VpcConfig

  The VPC configuration for the fleet.

Instance Attribute Details

#attributes_to_delete ⇒ Array<String>

The fleet attributes to delete.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-appstream/types.rb', line 2884

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

#compute_capacity ⇒ Types::ComputeCapacity

The desired capacity for the fleet.

Returns:

• (Types::ComputeCapacity)

# File 'lib/aws-sdk-appstream/types.rb', line 2884

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

#delete_vpc_config ⇒ Boolean

Deletes the VPC association for the specified fleet.

Returns:

• (Boolean)

# File 'lib/aws-sdk-appstream/types.rb', line 2884

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

#description ⇒ String

The description to display.

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 2884

class UpdateFleetRequest < Struct.new(
  :image_name,
  :image_arn,
  :name,
  :instance_type,
  :compute_capacity,
  :vpc_config,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :delete_vpc_config,
  :description,
  :display_name,
  :enable_default_internet_access,
  :domain_join_info,
  :attributes_to_delete)
  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. By default, the value is 900 seconds (15 minutes).

Returns:

• (Integer)

# File 'lib/aws-sdk-appstream/types.rb', line 2884

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

#display_name ⇒ String

The fleet name to display.

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 2884

class UpdateFleetRequest < Struct.new(
  :image_name,
  :image_arn,
  :name,
  :instance_type,
  :compute_capacity,
  :vpc_config,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :delete_vpc_config,
  :description,
  :display_name,
  :enable_default_internet_access,
  :domain_join_info,
  :attributes_to_delete)
  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:

• (Types::DomainJoinInfo)

# File 'lib/aws-sdk-appstream/types.rb', line 2884

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

#enable_default_internet_access ⇒ Boolean

Enables or disables default internet access for the fleet.

Returns:

• (Boolean)

# File 'lib/aws-sdk-appstream/types.rb', line 2884

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

#image_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 2884

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

#image_name ⇒ String

The name of the image used to create the fleet.

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 2884

class UpdateFleetRequest < Struct.new(
  :image_name,
  :image_arn,
  :name,
  :instance_type,
  :compute_capacity,
  :vpc_config,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :delete_vpc_config,
  :description,
  :display_name,
  :enable_default_internet_access,
  :domain_join_info,
  :attributes_to_delete)
  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)

# File 'lib/aws-sdk-appstream/types.rb', line 2884

class UpdateFleetRequest < Struct.new(
  :image_name,
  :image_arn,
  :name,
  :instance_type,
  :compute_capacity,
  :vpc_config,
  :max_user_duration_in_seconds,
  :disconnect_timeout_in_seconds,
  :delete_vpc_config,
  :description,
  :display_name,
  :enable_default_internet_access,
  :domain_join_info,
  :attributes_to_delete)
  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. By default, the value is 900 seconds (15 minutes).

Returns:

• (Integer)

# File 'lib/aws-sdk-appstream/types.rb', line 2884

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

#name ⇒ String

A unique name for the fleet.

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 2884

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

#vpc_config ⇒ Types::VpcConfig

The VPC configuration for the fleet.

Returns:

• (Types::VpcConfig)

# File 'lib/aws-sdk-appstream/types.rb', line 2884

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