data_cells_filters

Creates, updates, deletes or gets a data_cells_filter resource or lists data_cells_filters in a region

Overview

Name	data_cells_filters
Type	Resource
Description	A resource schema representing a Lake Formation Data Cells Filter.
Id	awscc.lakeformation.data_cells_filters

Fields

get (all properties)

Name	Datatype	Description
table_catalog_id	string	The Catalog Id of the Table on which to create a Data Cells Filter.
database_name	string	The name of the Database that the Table resides in.
▶row_filter	object	An object representing the Data Cells Filter's Row Filter. Either a Filter Expression or a Wildcard is required
column_names	array	A list of columns to be included in this Data Cells Filter.
column_wildcard	object	An object representing the Data Cells Filter's Columns. Either Column Names or a Wildcard is required
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
table_catalog_id	string	The Catalog Id of the Table on which to create a Data Cells Filter.
database_name	string	The name of the Database that the Table resides in.
region	string	AWS region.

For more information, see AWS::LakeFormation::DataCellsFilter.

Methods

Name	Resource	Accessible by	Required Params
create_resource	data_cells_filters	INSERT	TableCatalogId, DatabaseName, TableName, Name, region
delete_resource	data_cells_filters	DELETE	Identifier, region
list_resources	data_cells_filters_list_only	SELECT	region
get_resource	data_cells_filters	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual data_cells_filter.

SELECT
  region,
  table_catalog_id,
  database_name,
  table_name,
  name,
  row_filter,
  column_names,
  column_wildcard
FROM awscc.lakeformation.data_cells_filters
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ table_catalog_id }}|{{ database_name }}|{{ table_name }}|{{ name }}';

list (identifiers only)

Lists all data_cells_filters in a region.

SELECT
  region,
  table_catalog_id,
  database_name,
  table_name,
  name
FROM awscc.lakeformation.data_cells_filters_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new data_cells_filter resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.lakeformation.data_cells_filters (
  TableCatalogId,
  DatabaseName,
  TableName,
  Name,
  region
)
SELECT
  '{{ table_catalog_id }}',
  '{{ database_name }}',
  '{{ table_name }}',
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.lakeformation.data_cells_filters (
  TableCatalogId,
  DatabaseName,
  TableName,
  Name,
  RowFilter,
  ColumnNames,
  ColumnWildcard,
  region
)
SELECT
  '{{ table_catalog_id }}',
  '{{ database_name }}',
  '{{ table_name }}',
  '{{ name }}',
  '{{ row_filter }}',
  '{{ column_names }}',
  '{{ column_wildcard }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: data_cells_filter
    props:
      - name: table_catalog_id
        value: '{{ table_catalog_id }}'
      - name: database_name
        value: '{{ database_name }}'
      - name: table_name
        value: null
      - name: name
        value: null
      - name: row_filter
        value:
          filter_expression: '{{ filter_expression }}'
          all_rows_wildcard: {}
      - name: column_names
        value:
          - null
      - name: column_wildcard
        value:
          excluded_column_names: null

DELETE example

/*+ delete */
DELETE FROM awscc.lakeformation.data_cells_filters
WHERE
  Identifier = '{{ table_catalog_id }}|{{ database_name }}|{{ table_name }}|{{ name }}' AND
  region = 'us-east-1';

Permissions

To operate on the data_cells_filters resource, the following permissions are required:

Create

lakeformation:CreateDataCellsFilter,
glue:GetTable

Delete

lakeformation:DeleteDataCellsFilter

Read

lakeformation:ListDataCellsFilter

List

lakeformation:ListDataCellsFilter