Package software.amazon.awscdk.services.quicksight

Interface CfnDataSet.ColumnLevelPermissionRuleProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSet.ColumnLevelPermissionRuleProperty.Jsii$Proxy

Enclosing class:

CfnDataSet

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

A rule defined to grant access on one or more restricted columns.

Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.

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.*;
 ColumnLevelPermissionRuleProperty columnLevelPermissionRuleProperty = ColumnLevelPermissionRuleProperty.builder()
         .columnNames(List.of("columnNames"))
         .principals(List.of("principals"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSet.ColumnLevelPermissionRuleProperty.Builder	builder()
default List<String>	getColumnNames()	An array of column names.
default List<String>	getPrincipals()	An array of Amazon Resource Names (ARNs) for Quick Suite users or groups.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getColumnNames

@Stability(Stable)
@Nullable
default List<String> getColumnNames()

An array of column names.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columnlevelpermissionrule.html#cfn-quicksight-dataset-columnlevelpermissionrule-columnnames

getPrincipals

@Stability(Stable)
@Nullable
default List<String> getPrincipals()

An array of Amazon Resource Names (ARNs) for Quick Suite users or groups.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columnlevelpermissionrule.html#cfn-quicksight-dataset-columnlevelpermissionrule-principals

builder

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

Returns:

a CfnDataSet.ColumnLevelPermissionRuleProperty.Builder of CfnDataSet.ColumnLevelPermissionRuleProperty