AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::LakeFormation::DataCellsFilter

CfnDataCellsFilter

A structure that represents a data cell filter with column-level, row-level, and/or cell-level security. Data cell filters belong to a specific table in a Data Catalog . During a stack operation, AWS CloudFormation calls the AWS Lake Formation `CreateDataCellsFilter` API operation to create a `DataCellsFilter` resource, and calls the `DeleteDataCellsFilter` API operation to delete it.

Import

import { CfnDataCellsFilter } from 'aws-cdk-lib/aws-lakeformation';

Or use the module namespace:

import * as lakeformation from 'aws-cdk-lib/aws-lakeformation';
// lakeformation.CfnDataCellsFilter

Properties

Configuration passed to the constructor as CfnDataCellsFilterProps.

databaseNameRequired
string

UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html) . A database in the Data Catalog .

nameRequired
string

UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html) . The name given by the user to the data filter cell.

tableCatalogIdRequired
string

Catalog id string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html) . The ID of the catalog to which the table belongs.

tableNameRequired
string

UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html) . A table in the database.

columnNamesOptional
string[]

An array of UTF-8 strings. A list of column names.

columnWildcardOptional
IResolvable | ColumnWildcardProperty

A wildcard with exclusions. You must specify either a `ColumnNames` list or the `ColumnWildCard` .

rowFilterOptional
IResolvable | RowFilterProperty

A PartiQL predicate.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter