Package software.amazon.awscdk.services.lakeformation

Interface CfnDataCellsFilterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataCellsFilterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.110.0 (build 336b265)",
           date="2025-04-22T23:08:15.449Z")
@Stability(Stable)
public interface CfnDataCellsFilterProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.lakeformation.*;
 Object allRowsWildcard;
 CfnDataCellsFilterProps cfnDataCellsFilterProps = CfnDataCellsFilterProps.builder()
         .databaseName("databaseName")
         .name("name")
         .tableCatalogId("tableCatalogId")
         .tableName("tableName")
         // the properties below are optional
         .columnNames(List.of("columnNames"))
         .columnWildcard(ColumnWildcardProperty.builder()
                 .excludedColumnNames(List.of("excludedColumnNames"))
                 .build())
         .rowFilter(RowFilterProperty.builder()
                 .allRowsWildcard(allRowsWildcard)
                 .filterExpression("filterExpression")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataCellsFilterProps.Builder	builder()
default List<String>	getColumnNames()	An array of UTF-8 strings.
default Object	getColumnWildcard()	A wildcard with exclusions.
String	getDatabaseName()	UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .
String	getName()	UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .
default Object	getRowFilter()	A PartiQL predicate.
String	getTableCatalogId()	Catalog id string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .
String	getTableName()	UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatabaseName

@Stability(Stable)
@NotNull
String getDatabaseName()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-databasename

getName

@Stability(Stable)
@NotNull
String getName()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-name

getTableCatalogId

@Stability(Stable)
@NotNull
String getTableCatalogId()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-tablecatalogid

getTableName

@Stability(Stable)
@NotNull
String getTableName()

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

A table in the database.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-tablename

getColumnNames

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

An array of UTF-8 strings.

A list of column names.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-columnnames

getColumnWildcard

@Stability(Stable)
@Nullable
default Object getColumnWildcard()

A wildcard with exclusions.

You must specify either a ColumnNames list or the ColumnWildCard .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-columnwildcard

getRowFilter

@Stability(Stable)
@Nullable
default Object getRowFilter()

A PartiQL predicate.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-rowfilter

builder

@Stability(Stable)
static CfnDataCellsFilterProps.Builder builder()

Returns:

a CfnDataCellsFilterProps.Builder of CfnDataCellsFilterProps