aws-cdk-lib.aws_lakeformation.CfnDataCellsFilterProps

interface CfnDataCellsFilterProps

LanguageType name
.NETAmazon.CDK.AWS.LakeFormation.CfnDataCellsFilterProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslakeformation#CfnDataCellsFilterProps
Javasoftware.amazon.awscdk.services.lakeformation.CfnDataCellsFilterProps
Pythonaws_cdk.aws_lakeformation.CfnDataCellsFilterProps
TypeScript aws-cdk-lib » aws_lakeformation » CfnDataCellsFilterProps

Properties for defining a CfnDataCellsFilter.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lakeformation as lakeformation } from 'aws-cdk-lib';

declare const allRowsWildcard: any;
const cfnDataCellsFilterProps: lakeformation.CfnDataCellsFilterProps = {
  databaseName: 'databaseName',
  name: 'name',
  tableCatalogId: 'tableCatalogId',
  tableName: 'tableName',

  // the properties below are optional
  columnNames: ['columnNames'],
  columnWildcard: {
    excludedColumnNames: ['excludedColumnNames'],
  },
  rowFilter: {
    allRowsWildcard: allRowsWildcard,
    filterExpression: 'filterExpression',
  },
};

Properties

NameTypeDescription
databaseNamestringUTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .
namestringUTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .
tableCatalogIdstringCatalog id string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .
tableNamestringUTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .
columnNames?string[]An array of UTF-8 strings.
columnWildcard?IResolvable | ColumnWildcardPropertyA wildcard with exclusions.
rowFilter?IResolvable | RowFilterPropertyA PartiQL predicate.

databaseName

Type: string

UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .

A database in the Data Catalog .


name

Type: string

UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .

The name given by the user to the data filter cell.


tableCatalogId

Type: string

Catalog id string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .

The ID of the catalog to which the table belongs.


tableName

Type: string

UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .

A table in the database.


columnNames?

Type: string[] (optional)

An array of UTF-8 strings.

A list of column names.


columnWildcard?

Type: IResolvable | ColumnWildcardProperty (optional)

A wildcard with exclusions.

You must specify either a ColumnNames list or the ColumnWildCard .


rowFilter?

Type: IResolvable | RowFilterProperty (optional)

A PartiQL predicate.