Amazonka.QuickSight.Types.RowLevelPermissionDataSet

Documentation

data RowLevelPermissionDataSet

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

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

• namespace :: Maybe Text

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

• status :: Maybe Status

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

• 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

FromJSON RowLevelPermissionDataSet

Defined in Amazonka.QuickSight.Types.RowLevelPermissionDataSet

Methods

parseJSON :: Value -> Parser RowLevelPermissionDataSet

parseJSONList :: Value -> Parser [RowLevelPermissionDataSet]

ToJSON RowLevelPermissionDataSet

Defined in Amazonka.QuickSight.Types.RowLevelPermissionDataSet

Methods

toJSON :: RowLevelPermissionDataSet -> Value

toEncoding :: RowLevelPermissionDataSet -> Encoding

toJSONList :: [RowLevelPermissionDataSet] -> Value

toEncodingList :: [RowLevelPermissionDataSet] -> Encoding

Generic RowLevelPermissionDataSet

Defined in Amazonka.QuickSight.Types.RowLevelPermissionDataSet

Associated Types

type Rep RowLevelPermissionDataSet :: Type -> Type

Methods

from :: RowLevelPermissionDataSet -> Rep RowLevelPermissionDataSet x

to :: Rep RowLevelPermissionDataSet x -> RowLevelPermissionDataSet

Read RowLevelPermissionDataSet

Defined in Amazonka.QuickSight.Types.RowLevelPermissionDataSet

Methods

readsPrec :: Int -> ReadS RowLevelPermissionDataSet

readList :: ReadS [RowLevelPermissionDataSet]

readPrec :: ReadPrec RowLevelPermissionDataSet

readListPrec :: ReadPrec [RowLevelPermissionDataSet]

Show RowLevelPermissionDataSet

Defined in Amazonka.QuickSight.Types.RowLevelPermissionDataSet

Methods

showsPrec :: Int -> RowLevelPermissionDataSet -> ShowS

show :: RowLevelPermissionDataSet -> String

showList :: [RowLevelPermissionDataSet] -> ShowS

NFData RowLevelPermissionDataSet

Defined in Amazonka.QuickSight.Types.RowLevelPermissionDataSet

Methods

rnf :: RowLevelPermissionDataSet -> ()

Eq RowLevelPermissionDataSet

Defined in Amazonka.QuickSight.Types.RowLevelPermissionDataSet

Methods

(==) :: RowLevelPermissionDataSet -> RowLevelPermissionDataSet -> Bool

(/=) :: RowLevelPermissionDataSet -> RowLevelPermissionDataSet -> Bool

Hashable RowLevelPermissionDataSet

Defined in Amazonka.QuickSight.Types.RowLevelPermissionDataSet

Methods

hashWithSalt :: Int -> RowLevelPermissionDataSet -> Int

hash :: RowLevelPermissionDataSet -> Int

type Rep RowLevelPermissionDataSet

Defined in Amazonka.QuickSight.Types.RowLevelPermissionDataSet

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

newRowLevelPermissionDataSet

Arguments

:: Text

$sel:arn:RowLevelPermissionDataSet'

-> RowLevelPermissionPolicy

$sel:permissionPolicy:RowLevelPermissionDataSet'

-> RowLevelPermissionDataSet

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: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:namespace:RowLevelPermissionDataSet', rowLevelPermissionDataSet_namespace - The namespace associated with the dataset that contains permissions for RLS.

$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: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_formatVersion :: Lens' RowLevelPermissionDataSet (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.

rowLevelPermissionDataSet_namespace :: Lens' RowLevelPermissionDataSet (Maybe Text)

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

rowLevelPermissionDataSet_status :: Lens' RowLevelPermissionDataSet (Maybe Status)

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

rowLevelPermissionDataSet_arn :: Lens' RowLevelPermissionDataSet Text

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

rowLevelPermissionDataSet_permissionPolicy :: Lens' RowLevelPermissionDataSet RowLevelPermissionPolicy

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