Package software.amazon.awscdk.services.quicksight

Interface CfnDataSet.RowLevelPermissionDataSetProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSet.RowLevelPermissionDataSetProperty.Jsii$Proxy

Enclosing class:

CfnDataSet

@Stability(Stable)
public static interface CfnDataSet.RowLevelPermissionDataSetProperty
extends software.amazon.jsii.JsiiSerializable

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:

 // 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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataSet.RowLevelPermissionDataSetProperty.Builder	A builder for CfnDataSet.RowLevelPermissionDataSetProperty
static final class	CfnDataSet.RowLevelPermissionDataSetProperty.Jsii$Proxy	An implementation for CfnDataSet.RowLevelPermissionDataSetProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSet.RowLevelPermissionDataSetProperty.Builder	builder()
String	getArn()	The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
default String	getFormatVersion()	The user or group rules associated with the dataset that contains permissions for RLS.
default String	getNamespace()	The namespace associated with the dataset that contains permissions for RLS.
String	getPermissionPolicy()	The type of permissions to use when interpreting the permissions for RLS.
default String	getStatus()	The status of the row-level security permission dataset.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getArn

@Stability(Stable)
@NotNull
String getArn()

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

getPermissionPolicy

@Stability(Stable)
@NotNull
String getPermissionPolicy()

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

getFormatVersion

@Stability(Stable)
@Nullable
default String getFormatVersion()

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

getNamespace

@Stability(Stable)
@Nullable
default String getNamespace()

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

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

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

builder

@Stability(Stable)
static CfnDataSet.RowLevelPermissionDataSetProperty.Builder builder()

Returns:

a CfnDataSet.RowLevelPermissionDataSetProperty.Builder of CfnDataSet.RowLevelPermissionDataSetProperty