Class: Aws::WorkSpacesThinClient::Types::Environment

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

Overview

Describes an environment.

See Also:

Constant Summary collapse

SENSITIVE = 
[:name, :desktop_endpoint, :tags]

Instance Attribute Summary collapse

Instance Attribute Details

#activation_code ⇒ String

The activation code to register a device to the environment.

Returns:

  • (String) 


560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 560

class Environment < Struct.new(
  :id,
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :desktop_type,
  :activation_code,
  :registered_devices_count,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :pending_software_set_id,
  :pending_software_set_version,
  :software_set_compliance_status,
  :created_at,
  :updated_at,
  :arn,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) of the environment.

Returns:

  • (String) 


560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 560

class Environment < Struct.new(
  :id,
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :desktop_type,
  :activation_code,
  :registered_devices_count,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :pending_software_set_id,
  :pending_software_set_version,
  :software_set_compliance_status,
  :created_at,
  :updated_at,
  :arn,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end

#created_at ⇒ Time

The timestamp of when the environment was created.

Returns:

  • (Time) 


560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 560

class Environment < Struct.new(
  :id,
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :desktop_type,
  :activation_code,
  :registered_devices_count,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :pending_software_set_id,
  :pending_software_set_version,
  :software_set_compliance_status,
  :created_at,
  :updated_at,
  :arn,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end

#desired_software_set_id ⇒ String

The ID of the software set to apply.

Returns:

  • (String) 


560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 560

class Environment < Struct.new(
  :id,
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :desktop_type,
  :activation_code,
  :registered_devices_count,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :pending_software_set_id,
  :pending_software_set_version,
  :software_set_compliance_status,
  :created_at,
  :updated_at,
  :arn,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end

#desktop_arn ⇒ String

The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.

Returns:

  • (String) 


560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 560

class Environment < Struct.new(
  :id,
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :desktop_type,
  :activation_code,
  :registered_devices_count,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :pending_software_set_id,
  :pending_software_set_version,
  :software_set_compliance_status,
  :created_at,
  :updated_at,
  :arn,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end

#desktop_endpoint ⇒ String

The URL for the identity provider login (only for environments that use AppStream 2.0).

Returns:

  • (String) 


560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 560

class Environment < Struct.new(
  :id,
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :desktop_type,
  :activation_code,
  :registered_devices_count,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :pending_software_set_id,
  :pending_software_set_version,
  :software_set_compliance_status,
  :created_at,
  :updated_at,
  :arn,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end

#desktop_type ⇒ String

The type of streaming desktop for the environment.

Returns:

  • (String) 


560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 560

class Environment < Struct.new(
  :id,
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :desktop_type,
  :activation_code,
  :registered_devices_count,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :pending_software_set_id,
  :pending_software_set_version,
  :software_set_compliance_status,
  :created_at,
  :updated_at,
  :arn,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end

#id ⇒ String

The ID of the environment.

Returns:

  • (String) 


560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 560

class Environment < Struct.new(
  :id,
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :desktop_type,
  :activation_code,
  :registered_devices_count,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :pending_software_set_id,
  :pending_software_set_version,
  :software_set_compliance_status,
  :created_at,
  :updated_at,
  :arn,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end

#kms_key_arn ⇒ String

The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the environment.

Returns:

  • (String) 


560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 560

class Environment < Struct.new(
  :id,
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :desktop_type,
  :activation_code,
  :registered_devices_count,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :pending_software_set_id,
  :pending_software_set_version,
  :software_set_compliance_status,
  :created_at,
  :updated_at,
  :arn,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end

#maintenance_window ⇒ Types::MaintenanceWindow

A specification for a time window to apply software updates.

Returns:



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 560

class Environment < Struct.new(
  :id,
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :desktop_type,
  :activation_code,
  :registered_devices_count,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :pending_software_set_id,
  :pending_software_set_version,
  :software_set_compliance_status,
  :created_at,
  :updated_at,
  :arn,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end

#name ⇒ String

The name of the environment.

Returns:

  • (String) 


560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 560

class Environment < Struct.new(
  :id,
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :desktop_type,
  :activation_code,
  :registered_devices_count,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :pending_software_set_id,
  :pending_software_set_version,
  :software_set_compliance_status,
  :created_at,
  :updated_at,
  :arn,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end

#pending_software_set_id ⇒ String

The ID of the software set that is pending to be installed.

Returns:

  • (String) 


560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 560

class Environment < Struct.new(
  :id,
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :desktop_type,
  :activation_code,
  :registered_devices_count,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :pending_software_set_id,
  :pending_software_set_version,
  :software_set_compliance_status,
  :created_at,
  :updated_at,
  :arn,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end

#pending_software_set_version ⇒ String

The version of the software set that is pending to be installed.

Returns:

  • (String) 


560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 560

class Environment < Struct.new(
  :id,
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :desktop_type,
  :activation_code,
  :registered_devices_count,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :pending_software_set_id,
  :pending_software_set_version,
  :software_set_compliance_status,
  :created_at,
  :updated_at,
  :arn,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end

#registered_devices_count ⇒ Integer

The number of devices registered to the environment.

Returns:

  • (Integer) 


560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 560

class Environment < Struct.new(
  :id,
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :desktop_type,
  :activation_code,
  :registered_devices_count,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :pending_software_set_id,
  :pending_software_set_version,
  :software_set_compliance_status,
  :created_at,
  :updated_at,
  :arn,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end

#software_set_compliance_status ⇒ String

Describes if the software currently installed on all devices in the environment is a supported version.

Returns:

  • (String) 


560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 560

class Environment < Struct.new(
  :id,
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :desktop_type,
  :activation_code,
  :registered_devices_count,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :pending_software_set_id,
  :pending_software_set_version,
  :software_set_compliance_status,
  :created_at,
  :updated_at,
  :arn,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end

#software_set_update_mode ⇒ String

An option to define which software updates to apply.

Returns:

  • (String) 


560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 560

class Environment < Struct.new(
  :id,
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :desktop_type,
  :activation_code,
  :registered_devices_count,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :pending_software_set_id,
  :pending_software_set_version,
  :software_set_compliance_status,
  :created_at,
  :updated_at,
  :arn,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end

#software_set_update_schedule ⇒ String

An option to define if software updates should be applied within a maintenance window.

Returns:

  • (String) 


560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 560

class Environment < Struct.new(
  :id,
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :desktop_type,
  :activation_code,
  :registered_devices_count,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :pending_software_set_id,
  :pending_software_set_version,
  :software_set_compliance_status,
  :created_at,
  :updated_at,
  :arn,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tag keys and optional values for the resource.

Returns:

  • (Hash<String,String>) 


560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 560

class Environment < Struct.new(
  :id,
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :desktop_type,
  :activation_code,
  :registered_devices_count,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :pending_software_set_id,
  :pending_software_set_version,
  :software_set_compliance_status,
  :created_at,
  :updated_at,
  :arn,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end

#updated_at ⇒ Time

The timestamp of when the device was updated.

Returns:

  • (Time) 


560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 560

class Environment < Struct.new(
  :id,
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :desktop_type,
  :activation_code,
  :registered_devices_count,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :pending_software_set_id,
  :pending_software_set_version,
  :software_set_compliance_status,
  :created_at,
  :updated_at,
  :arn,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end