libZSservicesZSamazonka-quicksightZSamazonka-quicksight
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.QuickSight.Types.RowLevelPermissionDataSet

Description

 
Synopsis

Documentation

data RowLevelPermissionDataSet Source #

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.

See: newRowLevelPermissionDataSet smart constructor.

Constructors

RowLevelPermissionDataSet' 

Fields

  • status :: Maybe Status

    The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

  • namespace :: Maybe Text

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

  • formatVersion :: Maybe RowLevelPermissionFormatVersion

    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.

  • arn :: Text

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

  • permissionPolicy :: RowLevelPermissionPolicy

    The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.

Instances

Instances details
Eq RowLevelPermissionDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RowLevelPermissionDataSet

Read RowLevelPermissionDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RowLevelPermissionDataSet

Show RowLevelPermissionDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RowLevelPermissionDataSet

Generic RowLevelPermissionDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RowLevelPermissionDataSet

Associated Types

type Rep RowLevelPermissionDataSet :: Type -> Type #

NFData RowLevelPermissionDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RowLevelPermissionDataSet

Hashable RowLevelPermissionDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RowLevelPermissionDataSet

ToJSON RowLevelPermissionDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RowLevelPermissionDataSet

FromJSON RowLevelPermissionDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RowLevelPermissionDataSet

type Rep RowLevelPermissionDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RowLevelPermissionDataSet

type Rep RowLevelPermissionDataSet = D1 ('MetaData "RowLevelPermissionDataSet" "Amazonka.QuickSight.Types.RowLevelPermissionDataSet" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "RowLevelPermissionDataSet'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Status)) :*: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "formatVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RowLevelPermissionFormatVersion)) :*: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "permissionPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RowLevelPermissionPolicy)))))

newRowLevelPermissionDataSet Source #

Create a value of RowLevelPermissionDataSet with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:RowLevelPermissionDataSet', rowLevelPermissionDataSet_status - The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

$sel:namespace:RowLevelPermissionDataSet', rowLevelPermissionDataSet_namespace - The namespace associated with the dataset that contains permissions for RLS.

$sel:formatVersion:RowLevelPermissionDataSet', rowLevelPermissionDataSet_formatVersion - 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.

$sel:arn:RowLevelPermissionDataSet', rowLevelPermissionDataSet_arn - The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

$sel:permissionPolicy:RowLevelPermissionDataSet', rowLevelPermissionDataSet_permissionPolicy - The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.

rowLevelPermissionDataSet_status :: Lens' RowLevelPermissionDataSet (Maybe Status) Source #

The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

rowLevelPermissionDataSet_namespace :: Lens' RowLevelPermissionDataSet (Maybe Text) Source #

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

rowLevelPermissionDataSet_formatVersion :: Lens' RowLevelPermissionDataSet (Maybe RowLevelPermissionFormatVersion) Source #

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.

rowLevelPermissionDataSet_arn :: Lens' RowLevelPermissionDataSet Text Source #

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

rowLevelPermissionDataSet_permissionPolicy :: Lens' RowLevelPermissionDataSet RowLevelPermissionPolicy Source #

The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.