aws-cdk-lib.aws_quicksight.CfnDataSet.RowLevelPermissionDataSetProperty

RowLevelPermissionDataSetProperty Struct

Information about a dataset that contains permissions for row-level security (RLS).

The permissions dataset maps fields to users or groups. For more information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Quick Sight User Guide .

The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const rowLevelPermissionDataSetProperty: quicksight.CfnDataSet.RowLevelPermissionDataSetProperty = {
  arn: 'arn',
  permissionPolicy: 'permissionPolicy',

  // the properties below are optional
  formatVersion: 'formatVersion',
  namespace: 'namespace',
  status: 'status',
};

Properties

arnstringarnstrarnStringArnstringArn*stringrequired#

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

formatVersionstringformat_versionstrformatVersionStringFormatVersionstringFormatVersion*string#

The user or group rules associated with the dataset that contains permissions for RLS.

By default, FormatVersion is VERSION_1 . When FormatVersion is VERSION_1 , UserName and GroupName are required. When FormatVersion is VERSION_2 , UserARN and GroupARN are required, and Namespace must not exist.

namespacestringnamespacestrnamespaceStringNamespacestringNamespace*string#

The namespace associated with the dataset that contains permissions for RLS.

permissionPolicystringpermission_policystrpermissionPolicyStringPermissionPolicystringPermissionPolicy*stringrequired#

The type of permissions to use when interpreting the permissions for RLS.

DENY_ACCESS is included for backward compatibility only.

statusstringstatusstrstatusStringStatusstringStatus*string#

The status of the row-level security permission dataset.

If enabled, the status is ENABLED . If disabled, the status is DISABLED .