Interface CfnDataSet.RowLevelPermissionDataSetProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnDataSet.RowLevelPermissionDataSetProperty extends
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 Amazon QuickSight User Guide .

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


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 RowLevelPermissionDataSetProperty rowLevelPermissionDataSetProperty = RowLevelPermissionDataSetProperty.builder()
         // the properties below are optional
  • Method Details

    • getArn

      @Stability(Stable) @NotNull String getArn()
      The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
    • 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.

    • 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.

    • getNamespace

      @Stability(Stable) @Nullable default String getNamespace()
      The namespace associated with the dataset that contains permissions for RLS.
    • 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 .

    • builder

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