/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace FinSpaceData { namespace Model { /** *

The structure for a permission group.

See Also:

AWS * API Reference

*/ class PermissionGroup { public: AWS_FINSPACEDATA_API PermissionGroup(); AWS_FINSPACEDATA_API PermissionGroup(Aws::Utils::Json::JsonView jsonValue); AWS_FINSPACEDATA_API PermissionGroup& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_FINSPACEDATA_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The unique identifier for the permission group.

*/ inline const Aws::String& GetPermissionGroupId() const{ return m_permissionGroupId; } /** *

The unique identifier for the permission group.

*/ inline bool PermissionGroupIdHasBeenSet() const { return m_permissionGroupIdHasBeenSet; } /** *

The unique identifier for the permission group.

*/ inline void SetPermissionGroupId(const Aws::String& value) { m_permissionGroupIdHasBeenSet = true; m_permissionGroupId = value; } /** *

The unique identifier for the permission group.

*/ inline void SetPermissionGroupId(Aws::String&& value) { m_permissionGroupIdHasBeenSet = true; m_permissionGroupId = std::move(value); } /** *

The unique identifier for the permission group.

*/ inline void SetPermissionGroupId(const char* value) { m_permissionGroupIdHasBeenSet = true; m_permissionGroupId.assign(value); } /** *

The unique identifier for the permission group.

*/ inline PermissionGroup& WithPermissionGroupId(const Aws::String& value) { SetPermissionGroupId(value); return *this;} /** *

The unique identifier for the permission group.

*/ inline PermissionGroup& WithPermissionGroupId(Aws::String&& value) { SetPermissionGroupId(std::move(value)); return *this;} /** *

The unique identifier for the permission group.

*/ inline PermissionGroup& WithPermissionGroupId(const char* value) { SetPermissionGroupId(value); return *this;} /** *

The name of the permission group.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the permission group.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the permission group.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the permission group.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the permission group.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

The name of the permission group.

*/ inline PermissionGroup& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the permission group.

*/ inline PermissionGroup& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the permission group.

*/ inline PermissionGroup& WithName(const char* value) { SetName(value); return *this;} /** *

A brief description for the permission group.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

A brief description for the permission group.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

A brief description for the permission group.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

A brief description for the permission group.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

A brief description for the permission group.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

A brief description for the permission group.

*/ inline PermissionGroup& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

A brief description for the permission group.

*/ inline PermissionGroup& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

A brief description for the permission group.

*/ inline PermissionGroup& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

Indicates the permissions that are granted to a specific group for accessing * the FinSpace application.

When assigning application * permissions, be aware that the permission ManageUsersAndGroups * allows users to grant themselves or others access to any functionality in their * FinSpace environment's application. It should only be granted to trusted * users.

  • CreateDataset – Group members * can create new datasets.

  • ManageClusters – Group * members can manage Apache Spark clusters from FinSpace notebooks.

  • *

    ManageUsersAndGroups – Group members can manage users and * permission groups. This is a privileged permission that allows users to grant * themselves or others access to any functionality in the application. It should * only be granted to trusted users.

  • * ManageAttributeSets – Group members can manage attribute sets.

    *
  • ViewAuditData – Group members can view audit * data.

  • AccessNotebooks – Group members will have * access to FinSpace notebooks.

  • * GetTemporaryCredentials – Group members can get temporary API * credentials.

*/ inline const Aws::Vector& GetApplicationPermissions() const{ return m_applicationPermissions; } /** *

Indicates the permissions that are granted to a specific group for accessing * the FinSpace application.

When assigning application * permissions, be aware that the permission ManageUsersAndGroups * allows users to grant themselves or others access to any functionality in their * FinSpace environment's application. It should only be granted to trusted * users.

  • CreateDataset – Group members * can create new datasets.

  • ManageClusters – Group * members can manage Apache Spark clusters from FinSpace notebooks.

  • *

    ManageUsersAndGroups – Group members can manage users and * permission groups. This is a privileged permission that allows users to grant * themselves or others access to any functionality in the application. It should * only be granted to trusted users.

  • * ManageAttributeSets – Group members can manage attribute sets.

    *
  • ViewAuditData – Group members can view audit * data.

  • AccessNotebooks – Group members will have * access to FinSpace notebooks.

  • * GetTemporaryCredentials – Group members can get temporary API * credentials.

*/ inline bool ApplicationPermissionsHasBeenSet() const { return m_applicationPermissionsHasBeenSet; } /** *

Indicates the permissions that are granted to a specific group for accessing * the FinSpace application.

When assigning application * permissions, be aware that the permission ManageUsersAndGroups * allows users to grant themselves or others access to any functionality in their * FinSpace environment's application. It should only be granted to trusted * users.

  • CreateDataset – Group members * can create new datasets.

  • ManageClusters – Group * members can manage Apache Spark clusters from FinSpace notebooks.

  • *

    ManageUsersAndGroups – Group members can manage users and * permission groups. This is a privileged permission that allows users to grant * themselves or others access to any functionality in the application. It should * only be granted to trusted users.

  • * ManageAttributeSets – Group members can manage attribute sets.

    *
  • ViewAuditData – Group members can view audit * data.

  • AccessNotebooks – Group members will have * access to FinSpace notebooks.

  • * GetTemporaryCredentials – Group members can get temporary API * credentials.

*/ inline void SetApplicationPermissions(const Aws::Vector& value) { m_applicationPermissionsHasBeenSet = true; m_applicationPermissions = value; } /** *

Indicates the permissions that are granted to a specific group for accessing * the FinSpace application.

When assigning application * permissions, be aware that the permission ManageUsersAndGroups * allows users to grant themselves or others access to any functionality in their * FinSpace environment's application. It should only be granted to trusted * users.

  • CreateDataset – Group members * can create new datasets.

  • ManageClusters – Group * members can manage Apache Spark clusters from FinSpace notebooks.

  • *

    ManageUsersAndGroups – Group members can manage users and * permission groups. This is a privileged permission that allows users to grant * themselves or others access to any functionality in the application. It should * only be granted to trusted users.

  • * ManageAttributeSets – Group members can manage attribute sets.

    *
  • ViewAuditData – Group members can view audit * data.

  • AccessNotebooks – Group members will have * access to FinSpace notebooks.

  • * GetTemporaryCredentials – Group members can get temporary API * credentials.

*/ inline void SetApplicationPermissions(Aws::Vector&& value) { m_applicationPermissionsHasBeenSet = true; m_applicationPermissions = std::move(value); } /** *

Indicates the permissions that are granted to a specific group for accessing * the FinSpace application.

When assigning application * permissions, be aware that the permission ManageUsersAndGroups * allows users to grant themselves or others access to any functionality in their * FinSpace environment's application. It should only be granted to trusted * users.

  • CreateDataset – Group members * can create new datasets.

  • ManageClusters – Group * members can manage Apache Spark clusters from FinSpace notebooks.

  • *

    ManageUsersAndGroups – Group members can manage users and * permission groups. This is a privileged permission that allows users to grant * themselves or others access to any functionality in the application. It should * only be granted to trusted users.

  • * ManageAttributeSets – Group members can manage attribute sets.

    *
  • ViewAuditData – Group members can view audit * data.

  • AccessNotebooks – Group members will have * access to FinSpace notebooks.

  • * GetTemporaryCredentials – Group members can get temporary API * credentials.

*/ inline PermissionGroup& WithApplicationPermissions(const Aws::Vector& value) { SetApplicationPermissions(value); return *this;} /** *

Indicates the permissions that are granted to a specific group for accessing * the FinSpace application.

When assigning application * permissions, be aware that the permission ManageUsersAndGroups * allows users to grant themselves or others access to any functionality in their * FinSpace environment's application. It should only be granted to trusted * users.

  • CreateDataset – Group members * can create new datasets.

  • ManageClusters – Group * members can manage Apache Spark clusters from FinSpace notebooks.

  • *

    ManageUsersAndGroups – Group members can manage users and * permission groups. This is a privileged permission that allows users to grant * themselves or others access to any functionality in the application. It should * only be granted to trusted users.

  • * ManageAttributeSets – Group members can manage attribute sets.

    *
  • ViewAuditData – Group members can view audit * data.

  • AccessNotebooks – Group members will have * access to FinSpace notebooks.

  • * GetTemporaryCredentials – Group members can get temporary API * credentials.

*/ inline PermissionGroup& WithApplicationPermissions(Aws::Vector&& value) { SetApplicationPermissions(std::move(value)); return *this;} /** *

Indicates the permissions that are granted to a specific group for accessing * the FinSpace application.

When assigning application * permissions, be aware that the permission ManageUsersAndGroups * allows users to grant themselves or others access to any functionality in their * FinSpace environment's application. It should only be granted to trusted * users.

  • CreateDataset – Group members * can create new datasets.

  • ManageClusters – Group * members can manage Apache Spark clusters from FinSpace notebooks.

  • *

    ManageUsersAndGroups – Group members can manage users and * permission groups. This is a privileged permission that allows users to grant * themselves or others access to any functionality in the application. It should * only be granted to trusted users.

  • * ManageAttributeSets – Group members can manage attribute sets.

    *
  • ViewAuditData – Group members can view audit * data.

  • AccessNotebooks – Group members will have * access to FinSpace notebooks.

  • * GetTemporaryCredentials – Group members can get temporary API * credentials.

*/ inline PermissionGroup& AddApplicationPermissions(const ApplicationPermission& value) { m_applicationPermissionsHasBeenSet = true; m_applicationPermissions.push_back(value); return *this; } /** *

Indicates the permissions that are granted to a specific group for accessing * the FinSpace application.

When assigning application * permissions, be aware that the permission ManageUsersAndGroups * allows users to grant themselves or others access to any functionality in their * FinSpace environment's application. It should only be granted to trusted * users.

  • CreateDataset – Group members * can create new datasets.

  • ManageClusters – Group * members can manage Apache Spark clusters from FinSpace notebooks.

  • *

    ManageUsersAndGroups – Group members can manage users and * permission groups. This is a privileged permission that allows users to grant * themselves or others access to any functionality in the application. It should * only be granted to trusted users.

  • * ManageAttributeSets – Group members can manage attribute sets.

    *
  • ViewAuditData – Group members can view audit * data.

  • AccessNotebooks – Group members will have * access to FinSpace notebooks.

  • * GetTemporaryCredentials – Group members can get temporary API * credentials.

*/ inline PermissionGroup& AddApplicationPermissions(ApplicationPermission&& value) { m_applicationPermissionsHasBeenSet = true; m_applicationPermissions.push_back(std::move(value)); return *this; } /** *

The timestamp at which the group was created in FinSpace. The value is * determined as epoch time in milliseconds.

*/ inline long long GetCreateTime() const{ return m_createTime; } /** *

The timestamp at which the group was created in FinSpace. The value is * determined as epoch time in milliseconds.

*/ inline bool CreateTimeHasBeenSet() const { return m_createTimeHasBeenSet; } /** *

The timestamp at which the group was created in FinSpace. The value is * determined as epoch time in milliseconds.

*/ inline void SetCreateTime(long long value) { m_createTimeHasBeenSet = true; m_createTime = value; } /** *

The timestamp at which the group was created in FinSpace. The value is * determined as epoch time in milliseconds.

*/ inline PermissionGroup& WithCreateTime(long long value) { SetCreateTime(value); return *this;} /** *

Describes the last time the permission group was updated. The value is * determined as epoch time in milliseconds.

*/ inline long long GetLastModifiedTime() const{ return m_lastModifiedTime; } /** *

Describes the last time the permission group was updated. The value is * determined as epoch time in milliseconds.

*/ inline bool LastModifiedTimeHasBeenSet() const { return m_lastModifiedTimeHasBeenSet; } /** *

Describes the last time the permission group was updated. The value is * determined as epoch time in milliseconds.

*/ inline void SetLastModifiedTime(long long value) { m_lastModifiedTimeHasBeenSet = true; m_lastModifiedTime = value; } /** *

Describes the last time the permission group was updated. The value is * determined as epoch time in milliseconds.

*/ inline PermissionGroup& WithLastModifiedTime(long long value) { SetLastModifiedTime(value); return *this;} /** *

Indicates the status of the user account within a permission group.

    *
  • ADDITION_IN_PROGRESS – The user account is currently being * added to the permission group.

  • ADDITION_SUCCESS * – The user account is successfully added to the permission group.

  • *

    REMOVAL_IN_PROGRESS – The user is currently being removed from * the permission group.

*/ inline const PermissionGroupMembershipStatus& GetMembershipStatus() const{ return m_membershipStatus; } /** *

Indicates the status of the user account within a permission group.

    *
  • ADDITION_IN_PROGRESS – The user account is currently being * added to the permission group.

  • ADDITION_SUCCESS * – The user account is successfully added to the permission group.

  • *

    REMOVAL_IN_PROGRESS – The user is currently being removed from * the permission group.

*/ inline bool MembershipStatusHasBeenSet() const { return m_membershipStatusHasBeenSet; } /** *

Indicates the status of the user account within a permission group.

    *
  • ADDITION_IN_PROGRESS – The user account is currently being * added to the permission group.

  • ADDITION_SUCCESS * – The user account is successfully added to the permission group.

  • *

    REMOVAL_IN_PROGRESS – The user is currently being removed from * the permission group.

*/ inline void SetMembershipStatus(const PermissionGroupMembershipStatus& value) { m_membershipStatusHasBeenSet = true; m_membershipStatus = value; } /** *

Indicates the status of the user account within a permission group.

    *
  • ADDITION_IN_PROGRESS – The user account is currently being * added to the permission group.

  • ADDITION_SUCCESS * – The user account is successfully added to the permission group.

  • *

    REMOVAL_IN_PROGRESS – The user is currently being removed from * the permission group.

*/ inline void SetMembershipStatus(PermissionGroupMembershipStatus&& value) { m_membershipStatusHasBeenSet = true; m_membershipStatus = std::move(value); } /** *

Indicates the status of the user account within a permission group.

    *
  • ADDITION_IN_PROGRESS – The user account is currently being * added to the permission group.

  • ADDITION_SUCCESS * – The user account is successfully added to the permission group.

  • *

    REMOVAL_IN_PROGRESS – The user is currently being removed from * the permission group.

*/ inline PermissionGroup& WithMembershipStatus(const PermissionGroupMembershipStatus& value) { SetMembershipStatus(value); return *this;} /** *

Indicates the status of the user account within a permission group.

    *
  • ADDITION_IN_PROGRESS – The user account is currently being * added to the permission group.

  • ADDITION_SUCCESS * – The user account is successfully added to the permission group.

  • *

    REMOVAL_IN_PROGRESS – The user is currently being removed from * the permission group.

*/ inline PermissionGroup& WithMembershipStatus(PermissionGroupMembershipStatus&& value) { SetMembershipStatus(std::move(value)); return *this;} private: Aws::String m_permissionGroupId; bool m_permissionGroupIdHasBeenSet = false; Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; Aws::Vector m_applicationPermissions; bool m_applicationPermissionsHasBeenSet = false; long long m_createTime; bool m_createTimeHasBeenSet = false; long long m_lastModifiedTime; bool m_lastModifiedTimeHasBeenSet = false; PermissionGroupMembershipStatus m_membershipStatus; bool m_membershipStatusHasBeenSet = false; }; } // namespace Model } // namespace FinSpaceData } // namespace Aws