interface RowLevelPermissionDataSetProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnDataSet.RowLevelPermissionDataSetProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDataSet_RowLevelPermissionDataSetProperty
Java	software.amazon.awscdk.services.quicksight.CfnDataSet.RowLevelPermissionDataSetProperty
Python	aws_cdk.aws_quicksight.CfnDataSet.RowLevelPermissionDataSetProperty
TypeScript	aws-cdk-lib » aws_quicksight » CfnDataSet » RowLevelPermissionDataSetProperty

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiondataset.html

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

Name	Type	Description
arn	string	The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
permissionPolicy	string	The type of permissions to use when interpreting the permissions for RLS.
formatVersion?	string	The user or group rules associated with the dataset that contains permissions for RLS.
namespace?	string	The namespace associated with the dataset that contains permissions for RLS.
status?	string	The status of the row-level security permission dataset.

---

arn

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiondataset.html#cfn-quicksight-dataset-rowlevelpermissiondataset-arn

---

permissionPolicy

Type: string

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

DENY_ACCESS is included for backward compatibility only.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiondataset.html#cfn-quicksight-dataset-rowlevelpermissiondataset-permissionpolicy

---

formatVersion?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiondataset.html#cfn-quicksight-dataset-rowlevelpermissiondataset-formatversion

---

namespace?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiondataset.html#cfn-quicksight-dataset-rowlevelpermissiondataset-namespace

---

status?

Type: string (optional)

The status of the row-level security permission dataset.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiondataset.html#cfn-quicksight-dataset-rowlevelpermissiondataset-status