CfnDataCellsFilterProps

class aws_cdk.aws_lakeformation.CfnDataCellsFilterProps(*, database_name, name, table_catalog_id, table_name, column_names=None, column_wildcard=None, row_filter=None)

Bases: object

Properties for defining a CfnDataCellsFilter.

Parameters:

  • database_name (str) – 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 (str) –

    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.

  • table_catalog_id (str) –

    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.

  • table_name (str) –

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

  • column_names (Optional[Sequence[str]]) – An array of UTF-8 strings. A list of column names.

  • column_wildcard (Union[IResolvable, ColumnWildcardProperty, Dict[str, Any], None]) – A wildcard with exclusions. You must specify either a ColumnNames list or the ColumnWildCard .

  • row_filter (Union[IResolvable, RowFilterProperty, Dict[str, Any], None]) – A PartiQL predicate.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lakeformation as lakeformation

# all_rows_wildcard: Any

cfn_data_cells_filter_props = lakeformation.CfnDataCellsFilterProps(
    database_name="databaseName",
    name="name",
    table_catalog_id="tableCatalogId",
    table_name="tableName",

    # the properties below are optional
    column_names=["columnNames"],
    column_wildcard=lakeformation.CfnDataCellsFilter.ColumnWildcardProperty(
        excluded_column_names=["excludedColumnNames"]
    ),
    row_filter=lakeformation.CfnDataCellsFilter.RowFilterProperty(
        all_rows_wildcard=all_rows_wildcard,
        filter_expression="filterExpression"
    )
)

Attributes

column_names

An array of UTF-8 strings.

A list of column names.

See:

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

column_wildcard

A wildcard with exclusions.

You must specify either a ColumnNames list or the ColumnWildCard .

See:

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

database_name

//docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html>`_ .

A database in the Data Catalog .

See:

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

Type:

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

name

//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.

See:

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

Type:

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

row_filter

A PartiQL predicate.

See:

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

table_catalog_id

//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.

See:

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

Type:

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

table_name

//docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html>`_ .

A table in the database.

See:

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

Type:

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