Class: Aws::WorkSpacesThinClient::Types::CreateEnvironmentRequest

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

Overview

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 117

class CreateEnvironmentRequest < Struct.new(
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :kms_key_arn,
  :client_token,
  :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) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 117

class CreateEnvironmentRequest < Struct.new(
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :kms_key_arn,
  :client_token,
  :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) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 117

class CreateEnvironmentRequest < Struct.new(
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :kms_key_arn,
  :client_token,
  :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) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 117

class CreateEnvironmentRequest < Struct.new(
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :kms_key_arn,
  :client_token,
  :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 to use to encrypt the environment.

Returns:

  • (String) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 117

class CreateEnvironmentRequest < Struct.new(
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :kms_key_arn,
  :client_token,
  :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:



117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 117

class CreateEnvironmentRequest < Struct.new(
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :kms_key_arn,
  :client_token,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end

#name ⇒ String

The name for the environment.

Returns:

  • (String) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 117

class CreateEnvironmentRequest < Struct.new(
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :kms_key_arn,
  :client_token,
  :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) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 117

class CreateEnvironmentRequest < Struct.new(
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :kms_key_arn,
  :client_token,
  :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) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 117

class CreateEnvironmentRequest < Struct.new(
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :kms_key_arn,
  :client_token,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A map of the key-value pairs of the tag or tags to assign to the resource.

Returns:

  • (Hash<String,String>) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'gems/aws-sdk-workspacesthinclient/lib/aws-sdk-workspacesthinclient/types.rb', line 117

class CreateEnvironmentRequest < Struct.new(
  :name,
  :desktop_arn,
  :desktop_endpoint,
  :software_set_update_schedule,
  :maintenance_window,
  :software_set_update_mode,
  :desired_software_set_id,
  :kms_key_arn,
  :client_token,
  :tags)
  SENSITIVE = [:name, :desktop_endpoint, :tags]
  include Aws::Structure
end