Class: Aws::WorkSpaces::Types::DefaultWorkspaceCreationProperties

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

Overview

Describes the default values that are used to create WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_security_group_idString

The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.

Returns:

  • (String)


1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1442

class DefaultWorkspaceCreationProperties < Struct.new(
  :enable_work_docs,
  :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_ouString

The organizational unit (OU) in the directory for the WorkSpace machine accounts.

Returns:

  • (String)


1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1442

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

Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.

Returns:

  • (Boolean)


1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1442

class DefaultWorkspaceCreationProperties < Struct.new(
  :enable_work_docs,
  :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_modeBoolean

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

Returns:

  • (Boolean)


1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1442

class DefaultWorkspaceCreationProperties < Struct.new(
  :enable_work_docs,
  :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_work_docsBoolean

Specifies whether the directory is enabled for Amazon WorkDocs.

Returns:

  • (Boolean)


1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1442

class DefaultWorkspaceCreationProperties < Struct.new(
  :enable_work_docs,
  :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_arnString

Indicates the IAM role ARN of the instance.

Returns:

  • (String)


1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1442

class DefaultWorkspaceCreationProperties < Struct.new(
  :enable_work_docs,
  :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_administratorBoolean

Specifies whether WorkSpace users are local administrators on their WorkSpaces.

Returns:

  • (Boolean)


1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1442

class DefaultWorkspaceCreationProperties < Struct.new(
  :enable_work_docs,
  :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