Class: Aws::WorkSpaces::Types::WorkspaceCreationProperties

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

Overview

Describes the default properties that are used for creating WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_security_group_id ⇒ String

The identifier of your custom security group.

Returns:

  • (String) 


5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5637

class WorkspaceCreationProperties < Struct.new(
  :enable_internet_access,
  :default_ou,
  :custom_security_group_id,
  :user_enabled_as_local_administrator,
  :enable_maintenance_mode,
  :instance_iam_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#default_ou ⇒ String

The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form "OU=value,DC=value,DC=value", where value is any string of characters, and the number of domain components (DCs) is two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.

  • To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.

  • The API doesn't validate whether the OU exists.

Returns:

  • (String) 


5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5637

class WorkspaceCreationProperties < Struct.new(
  :enable_internet_access,
  :default_ou,
  :custom_security_group_id,
  :user_enabled_as_local_administrator,
  :enable_maintenance_mode,
  :instance_iam_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#enable_internet_access ⇒ Boolean

Indicates whether internet access is enabled for your WorkSpaces.

Returns:

  • (Boolean) 


5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5637

class WorkspaceCreationProperties < Struct.new(
  :enable_internet_access,
  :default_ou,
  :custom_security_group_id,
  :user_enabled_as_local_administrator,
  :enable_maintenance_mode,
  :instance_iam_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#enable_maintenance_mode ⇒ Boolean

Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.

Returns:

  • (Boolean) 


5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5637

class WorkspaceCreationProperties < Struct.new(
  :enable_internet_access,
  :default_ou,
  :custom_security_group_id,
  :user_enabled_as_local_administrator,
  :enable_maintenance_mode,
  :instance_iam_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#instance_iam_role_arn ⇒ String

Indicates the IAM role ARN of the instance.

Returns:

  • (String) 


5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5637

class WorkspaceCreationProperties < Struct.new(
  :enable_internet_access,
  :default_ou,
  :custom_security_group_id,
  :user_enabled_as_local_administrator,
  :enable_maintenance_mode,
  :instance_iam_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#user_enabled_as_local_administrator ⇒ Boolean

Indicates whether users are local administrators of their WorkSpaces.

Returns:

  • (Boolean) 


5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5637

class WorkspaceCreationProperties < Struct.new(
  :enable_internet_access,
  :default_ou,
  :custom_security_group_id,
  :user_enabled_as_local_administrator,
  :enable_maintenance_mode,
  :instance_iam_role_arn)
  SENSITIVE = []
  include Aws::Structure
end