data_cells_filters

Creates, updates, deletes, gets or lists a data_cells_filters resource.

Overview

Name	data_cells_filters
Type	Resource
Id	aws.lakeformation.data_cells_filters

Fields

The following fields are returned by SELECT queries:

get_data_cells_filter

Name	Datatype	Description
column_names	array	A list of column names and/or nested column attributes. When specifying nested attributes, use a qualified dot (.) delimited format such as "address"."zip". Nested attributes within this list may not exceed a depth of 5.
column_wildcard	object	A wildcard with exclusions. You must specify either a ColumnNames list or the ColumnWildCard.
database_name	string	A database in the Glue Data Catalog. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
name	string	The name given by the user to the data filter cell. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
row_filter	object	A PartiQL predicate.
table_catalog_id	string	The ID of the catalog to which the table belongs. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
table_name	string	A table in the database. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
version_id	string	The ID of the data cells filter version. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)

list_data_cells_filter

Name	Datatype	Description
column_names	array	A list of column names and/or nested column attributes. When specifying nested attributes, use a qualified dot (.) delimited format such as "address"."zip". Nested attributes within this list may not exceed a depth of 5.
column_wildcard	object	A wildcard with exclusions. You must specify either a ColumnNames list or the ColumnWildCard.
database_name	string	A database in the Glue Data Catalog. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
name	string	The name given by the user to the data filter cell. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
row_filter	object	A PartiQL predicate.
table_catalog_id	string	The ID of the catalog to which the table belongs. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
table_name	string	A table in the database. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
version_id	string	The ID of the data cells filter version. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_cells_filter	select	region		Returns a data cells filter.
list_data_cells_filter	select	region		Lists all the data cell filters on a table.
create_data_cells_filter	insert	region, TableData		Creates a data cell filter to allow one to grant access to certain columns on certain rows.
update_data_cells_filter	update	region, TableData		Updates a data cell filter.
delete_data_cells_filter	delete	region		Deletes a data cell filter.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_data_cells_filter

Returns a data cells filter.

SELECT
column_names,
column_wildcard,
database_name,
name,
row_filter,
table_catalog_id,
table_name,
version_id
FROM aws.lakeformation.data_cells_filters
WHERE region = '{{ region }}' -- required
;

list_data_cells_filter

Lists all the data cell filters on a table.

SELECT
column_names,
column_wildcard,
database_name,
name,
row_filter,
table_catalog_id,
table_name,
version_id
FROM aws.lakeformation.data_cells_filters
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_data_cells_filter

Creates a data cell filter to allow one to grant access to certain columns on certain rows.

INSERT INTO aws.lakeformation.data_cells_filters (
TableData,
region
)
SELECT 
'{{ TableData }}' /* required */,
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: data_cells_filters
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_cells_filters resource.
  - name: TableData
    description: |
      A structure that describes certain columns on certain rows.
    value:
      TableCatalogId: "{{ TableCatalogId }}"
      DatabaseName: "{{ DatabaseName }}"
      TableName: "{{ TableName }}"
      Name: "{{ Name }}"
      RowFilter:
        FilterExpression: "{{ FilterExpression }}"
        AllRowsWildcard: "{{ AllRowsWildcard }}"
      ColumnNames:
        - "{{ ColumnNames }}"
      ColumnWildcard:
        ExcludedColumnNames:
          - "{{ ExcludedColumnNames }}"
      VersionId: "{{ VersionId }}"

UPDATE examples

update_data_cells_filter

Updates a data cell filter.

UPDATE aws.lakeformation.data_cells_filters
SET 
TableData = '{{ TableData }}'
WHERE 
region = '{{ region }}' --required
AND TableData = '{{ TableData }}' --required;

DELETE examples

delete_data_cells_filter

Deletes a data cell filter.

DELETE FROM aws.lakeformation.data_cells_filters
WHERE region = '{{ region }}' --required
;