Skip to content
v2.277.0

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.

Example ​

ts
// 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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

row_level_permission_data_set_property = quicksight.CfnDataSet.RowLevelPermissionDataSetProperty(
    arn="arn",
    permission_policy="permissionPolicy",

    # the properties below are optional
    format_version="formatVersion",
    namespace="namespace",
    status="status"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;

RowLevelPermissionDataSetProperty rowLevelPermissionDataSetProperty = RowLevelPermissionDataSetProperty.builder()
        .arn("arn")
        .permissionPolicy("permissionPolicy")

        // the properties below are optional
        .formatVersion("formatVersion")
        .namespace("namespace")
        .status("status")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var rowLevelPermissionDataSetProperty = new RowLevelPermissionDataSetProperty {
    Arn = "arn",
    PermissionPolicy = "permissionPolicy",

    // the properties below are optional
    FormatVersion = "formatVersion",
    Namespace = "namespace",
    Status = "status"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

rowLevelPermissionDataSetProperty := &RowLevelPermissionDataSetProperty{
	Arn: jsii.String("arn"),
	PermissionPolicy: jsii.String("permissionPolicy"),

	// the properties below are optional
	FormatVersion: jsii.String("formatVersion"),
	Namespace: jsii.String("namespace"),
	Status: jsii.String("status"),
}

Properties ​

arnstringarnstrarnStringArnstringArn*stringrequired#
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
formatVersionoptionalstringformat_versionoptionalstrformatVersionoptionalStringFormatVersionoptionalstringFormatVersionoptional*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.

namespaceoptionalstringnamespaceoptionalstrnamespaceoptionalStringNamespaceoptionalstringNamespaceoptional*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.

statusoptionalstringstatusoptionalstrstatusoptionalStringStatusoptionalstringStatusoptional*string#
The status of the row-level security permission dataset.

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