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

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

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 UpdateFleetRequest data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#attributes_to_deleteArray<String>

Fleet attributes to be deleted.

Returns:

  • (Array<String>)


1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1514

class UpdateFleetRequest < Struct.new(
  :image_name,
  :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_capacityTypes::ComputeCapacity

The parameters for the capacity allocated to the fleet.



1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1514

class UpdateFleetRequest < Struct.new(
  :image_name,
  :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_configBoolean

Delete the VPC association for the specified fleet.

Returns:

  • (Boolean)


1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1514

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

#descriptionString

The description displayed to end users on the AppStream 2.0 portal.

Returns:

  • (String)


1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1514

class UpdateFleetRequest < Struct.new(
  :image_name,
  :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_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)


1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1514

class UpdateFleetRequest < Struct.new(
  :image_name,
  :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_nameString

The name displayed to end users on the AppStream 2.0 portal.

Returns:

  • (String)


1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1514

class UpdateFleetRequest < Struct.new(
  :image_name,
  :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_infoTypes::DomainJoinInfo

The DirectoryName and OrganizationalUnitDistinguishedName values, which are used to join domains for the AppStream 2.0 streaming instances.



1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1514

class UpdateFleetRequest < Struct.new(
  :image_name,
  :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_accessBoolean

Enables or disables default internet access for the fleet.

Returns:

  • (Boolean)


1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1514

class UpdateFleetRequest < Struct.new(
  :image_name,
  :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_nameString

The image name from which a fleet is created.

Returns:

  • (String)


1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1514

class UpdateFleetRequest < Struct.new(
  :image_name,
  :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_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

  • stream.graphics-pro.4xlarge

  • stream.graphics-pro.8xlarge

  • stream.graphics-pro.16xlarge

  • stream.graphics-desktop.2xlarge

Returns:

  • (String)


1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1514

class UpdateFleetRequest < Struct.new(
  :image_name,
  :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_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)


1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1514

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

#nameString

The name of the fleet.

Returns:

  • (String)


1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1514

class UpdateFleetRequest < Struct.new(
  :image_name,
  :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_configTypes::VpcConfig

The VPC configuration for the fleet.

Returns:



1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1514

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