Skip to content
v2.277.0

ColumnLevelPermissionRuleProperty Struct ​

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 ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const columnLevelPermissionRuleProperty: quicksight.CfnDataSet.ColumnLevelPermissionRuleProperty = {
  columnNames: ['columnNames'],
  principals: ['principals'],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

column_level_permission_rule_property = quicksight.CfnDataSet.ColumnLevelPermissionRuleProperty(
    column_names=["columnNames"],
    principals=["principals"]
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var columnLevelPermissionRuleProperty = new ColumnLevelPermissionRuleProperty {
    ColumnNames = new [] { "columnNames" },
    Principals = new [] { "principals" }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

columnLevelPermissionRuleProperty := &ColumnLevelPermissionRuleProperty{
	ColumnNames: []*string{
		jsii.String("columnNames"),
	},
	Principals: []*string{
		jsii.String("principals"),
	},
}

Properties ​

columnNamesoptionalstring[]column_namesoptionaltyping.List[str]columnNamesoptionalList<String>ColumnNamesoptionalstring[]ColumnNamesoptional*[]*string#
An array of column names.
principalsoptionalstring[]principalsoptionaltyping.List[str]principalsoptionalList<String>Principalsoptionalstring[]Principalsoptional*[]*string#
An array of Amazon Resource Names (ARNs) for Quick users or groups.