AWS SDK for C++  1.9.124
AWS SDK for C++
Public Member Functions | List of all members
Aws::WorkSpaces::Model::WorkspaceCreationProperties Class Reference

#include <WorkspaceCreationProperties.h>

Public Member Functions

 WorkspaceCreationProperties ()
 
 WorkspaceCreationProperties (Aws::Utils::Json::JsonView jsonValue)
 
WorkspaceCreationPropertiesoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
bool GetEnableWorkDocs () const
 
bool EnableWorkDocsHasBeenSet () const
 
void SetEnableWorkDocs (bool value)
 
WorkspaceCreationPropertiesWithEnableWorkDocs (bool value)
 
bool GetEnableInternetAccess () const
 
bool EnableInternetAccessHasBeenSet () const
 
void SetEnableInternetAccess (bool value)
 
WorkspaceCreationPropertiesWithEnableInternetAccess (bool value)
 
const Aws::StringGetDefaultOu () const
 
bool DefaultOuHasBeenSet () const
 
void SetDefaultOu (const Aws::String &value)
 
void SetDefaultOu (Aws::String &&value)
 
void SetDefaultOu (const char *value)
 
WorkspaceCreationPropertiesWithDefaultOu (const Aws::String &value)
 
WorkspaceCreationPropertiesWithDefaultOu (Aws::String &&value)
 
WorkspaceCreationPropertiesWithDefaultOu (const char *value)
 
const Aws::StringGetCustomSecurityGroupId () const
 
bool CustomSecurityGroupIdHasBeenSet () const
 
void SetCustomSecurityGroupId (const Aws::String &value)
 
void SetCustomSecurityGroupId (Aws::String &&value)
 
void SetCustomSecurityGroupId (const char *value)
 
WorkspaceCreationPropertiesWithCustomSecurityGroupId (const Aws::String &value)
 
WorkspaceCreationPropertiesWithCustomSecurityGroupId (Aws::String &&value)
 
WorkspaceCreationPropertiesWithCustomSecurityGroupId (const char *value)
 
bool GetUserEnabledAsLocalAdministrator () const
 
bool UserEnabledAsLocalAdministratorHasBeenSet () const
 
void SetUserEnabledAsLocalAdministrator (bool value)
 
WorkspaceCreationPropertiesWithUserEnabledAsLocalAdministrator (bool value)
 
bool GetEnableMaintenanceMode () const
 
bool EnableMaintenanceModeHasBeenSet () const
 
void SetEnableMaintenanceMode (bool value)
 
WorkspaceCreationPropertiesWithEnableMaintenanceMode (bool value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 34 of file WorkspaceCreationProperties.h.

Constructor & Destructor Documentation

◆ WorkspaceCreationProperties() [1/2]

Aws::WorkSpaces::Model::WorkspaceCreationProperties::WorkspaceCreationProperties ( )

◆ WorkspaceCreationProperties() [2/2]

Aws::WorkSpaces::Model::WorkspaceCreationProperties::WorkspaceCreationProperties ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ CustomSecurityGroupIdHasBeenSet()

bool Aws::WorkSpaces::Model::WorkspaceCreationProperties::CustomSecurityGroupIdHasBeenSet ( ) const
inline

The identifier of your custom security group.

Definition at line 274 of file WorkspaceCreationProperties.h.

◆ DefaultOuHasBeenSet()

bool Aws::WorkSpaces::Model::WorkspaceCreationProperties::DefaultOuHasBeenSet ( ) const
inline

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=<i>value</i>,DC=<i>value</i>,DC=<i>value</i>", 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.

Definition at line 167 of file WorkspaceCreationProperties.h.

◆ EnableInternetAccessHasBeenSet()

bool Aws::WorkSpaces::Model::WorkspaceCreationProperties::EnableInternetAccessHasBeenSet ( ) const
inline

Indicates whether internet access is enabled for your WorkSpaces.

Definition at line 124 of file WorkspaceCreationProperties.h.

◆ EnableMaintenanceModeHasBeenSet()

bool Aws::WorkSpaces::Model::WorkspaceCreationProperties::EnableMaintenanceModeHasBeenSet ( ) const
inline

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

Definition at line 342 of file WorkspaceCreationProperties.h.

◆ EnableWorkDocsHasBeenSet()

bool Aws::WorkSpaces::Model::WorkspaceCreationProperties::EnableWorkDocsHasBeenSet ( ) const
inline

Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.

If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.

If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.

Definition at line 77 of file WorkspaceCreationProperties.h.

◆ GetCustomSecurityGroupId()

const Aws::String& Aws::WorkSpaces::Model::WorkspaceCreationProperties::GetCustomSecurityGroupId ( ) const
inline

The identifier of your custom security group.

Definition at line 269 of file WorkspaceCreationProperties.h.

◆ GetDefaultOu()

const Aws::String& Aws::WorkSpaces::Model::WorkspaceCreationProperties::GetDefaultOu ( ) const
inline

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=<i>value</i>,DC=<i>value</i>,DC=<i>value</i>", 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.

Definition at line 151 of file WorkspaceCreationProperties.h.

◆ GetEnableInternetAccess()

bool Aws::WorkSpaces::Model::WorkspaceCreationProperties::GetEnableInternetAccess ( ) const
inline

Indicates whether internet access is enabled for your WorkSpaces.

Definition at line 119 of file WorkspaceCreationProperties.h.

◆ GetEnableMaintenanceMode()

bool Aws::WorkSpaces::Model::WorkspaceCreationProperties::GetEnableMaintenanceMode ( ) const
inline

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

Definition at line 334 of file WorkspaceCreationProperties.h.

◆ GetEnableWorkDocs()

bool Aws::WorkSpaces::Model::WorkspaceCreationProperties::GetEnableWorkDocs ( ) const
inline

Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.

If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.

If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.

Definition at line 59 of file WorkspaceCreationProperties.h.

◆ GetUserEnabledAsLocalAdministrator()

bool Aws::WorkSpaces::Model::WorkspaceCreationProperties::GetUserEnabledAsLocalAdministrator ( ) const
inline

Indicates whether users are local administrators of their WorkSpaces.

Definition at line 310 of file WorkspaceCreationProperties.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::WorkSpaces::Model::WorkspaceCreationProperties::Jsonize ( ) const

◆ operator=()

WorkspaceCreationProperties& Aws::WorkSpaces::Model::WorkspaceCreationProperties::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetCustomSecurityGroupId() [1/3]

void Aws::WorkSpaces::Model::WorkspaceCreationProperties::SetCustomSecurityGroupId ( Aws::String &&  value)
inline

The identifier of your custom security group.

Definition at line 284 of file WorkspaceCreationProperties.h.

◆ SetCustomSecurityGroupId() [2/3]

void Aws::WorkSpaces::Model::WorkspaceCreationProperties::SetCustomSecurityGroupId ( const Aws::String value)
inline

The identifier of your custom security group.

Definition at line 279 of file WorkspaceCreationProperties.h.

◆ SetCustomSecurityGroupId() [3/3]

void Aws::WorkSpaces::Model::WorkspaceCreationProperties::SetCustomSecurityGroupId ( const char *  value)
inline

The identifier of your custom security group.

Definition at line 289 of file WorkspaceCreationProperties.h.

◆ SetDefaultOu() [1/3]

void Aws::WorkSpaces::Model::WorkspaceCreationProperties::SetDefaultOu ( Aws::String &&  value)
inline

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=<i>value</i>,DC=<i>value</i>,DC=<i>value</i>", 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.

Definition at line 199 of file WorkspaceCreationProperties.h.

◆ SetDefaultOu() [2/3]

void Aws::WorkSpaces::Model::WorkspaceCreationProperties::SetDefaultOu ( const Aws::String value)
inline

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=<i>value</i>,DC=<i>value</i>,DC=<i>value</i>", 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.

Definition at line 183 of file WorkspaceCreationProperties.h.

◆ SetDefaultOu() [3/3]

void Aws::WorkSpaces::Model::WorkspaceCreationProperties::SetDefaultOu ( const char *  value)
inline

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=<i>value</i>,DC=<i>value</i>,DC=<i>value</i>", 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.

Definition at line 215 of file WorkspaceCreationProperties.h.

◆ SetEnableInternetAccess()

void Aws::WorkSpaces::Model::WorkspaceCreationProperties::SetEnableInternetAccess ( bool  value)
inline

Indicates whether internet access is enabled for your WorkSpaces.

Definition at line 129 of file WorkspaceCreationProperties.h.

◆ SetEnableMaintenanceMode()

void Aws::WorkSpaces::Model::WorkspaceCreationProperties::SetEnableMaintenanceMode ( bool  value)
inline

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

Definition at line 350 of file WorkspaceCreationProperties.h.

◆ SetEnableWorkDocs()

void Aws::WorkSpaces::Model::WorkspaceCreationProperties::SetEnableWorkDocs ( bool  value)
inline

Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.

If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.

If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.

Definition at line 95 of file WorkspaceCreationProperties.h.

◆ SetUserEnabledAsLocalAdministrator()

void Aws::WorkSpaces::Model::WorkspaceCreationProperties::SetUserEnabledAsLocalAdministrator ( bool  value)
inline

Indicates whether users are local administrators of their WorkSpaces.

Definition at line 320 of file WorkspaceCreationProperties.h.

◆ UserEnabledAsLocalAdministratorHasBeenSet()

bool Aws::WorkSpaces::Model::WorkspaceCreationProperties::UserEnabledAsLocalAdministratorHasBeenSet ( ) const
inline

Indicates whether users are local administrators of their WorkSpaces.

Definition at line 315 of file WorkspaceCreationProperties.h.

◆ WithCustomSecurityGroupId() [1/3]

WorkspaceCreationProperties& Aws::WorkSpaces::Model::WorkspaceCreationProperties::WithCustomSecurityGroupId ( Aws::String &&  value)
inline

The identifier of your custom security group.

Definition at line 299 of file WorkspaceCreationProperties.h.

◆ WithCustomSecurityGroupId() [2/3]

WorkspaceCreationProperties& Aws::WorkSpaces::Model::WorkspaceCreationProperties::WithCustomSecurityGroupId ( const Aws::String value)
inline

The identifier of your custom security group.

Definition at line 294 of file WorkspaceCreationProperties.h.

◆ WithCustomSecurityGroupId() [3/3]

WorkspaceCreationProperties& Aws::WorkSpaces::Model::WorkspaceCreationProperties::WithCustomSecurityGroupId ( const char *  value)
inline

The identifier of your custom security group.

Definition at line 304 of file WorkspaceCreationProperties.h.

◆ WithDefaultOu() [1/3]

WorkspaceCreationProperties& Aws::WorkSpaces::Model::WorkspaceCreationProperties::WithDefaultOu ( Aws::String &&  value)
inline

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=<i>value</i>,DC=<i>value</i>,DC=<i>value</i>", 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.

Definition at line 247 of file WorkspaceCreationProperties.h.

◆ WithDefaultOu() [2/3]

WorkspaceCreationProperties& Aws::WorkSpaces::Model::WorkspaceCreationProperties::WithDefaultOu ( const Aws::String value)
inline

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=<i>value</i>,DC=<i>value</i>,DC=<i>value</i>", 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.

Definition at line 231 of file WorkspaceCreationProperties.h.

◆ WithDefaultOu() [3/3]

WorkspaceCreationProperties& Aws::WorkSpaces::Model::WorkspaceCreationProperties::WithDefaultOu ( const char *  value)
inline

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=<i>value</i>,DC=<i>value</i>,DC=<i>value</i>", 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.

Definition at line 263 of file WorkspaceCreationProperties.h.

◆ WithEnableInternetAccess()

WorkspaceCreationProperties& Aws::WorkSpaces::Model::WorkspaceCreationProperties::WithEnableInternetAccess ( bool  value)
inline

Indicates whether internet access is enabled for your WorkSpaces.

Definition at line 134 of file WorkspaceCreationProperties.h.

◆ WithEnableMaintenanceMode()

WorkspaceCreationProperties& Aws::WorkSpaces::Model::WorkspaceCreationProperties::WithEnableMaintenanceMode ( bool  value)
inline

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

Definition at line 358 of file WorkspaceCreationProperties.h.

◆ WithEnableWorkDocs()

WorkspaceCreationProperties& Aws::WorkSpaces::Model::WorkspaceCreationProperties::WithEnableWorkDocs ( bool  value)
inline

Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.

If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.

If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.

Definition at line 113 of file WorkspaceCreationProperties.h.

◆ WithUserEnabledAsLocalAdministrator()

WorkspaceCreationProperties& Aws::WorkSpaces::Model::WorkspaceCreationProperties::WithUserEnabledAsLocalAdministrator ( bool  value)
inline

Indicates whether users are local administrators of their WorkSpaces.

Definition at line 325 of file WorkspaceCreationProperties.h.


The documentation for this class was generated from the following file: