software.amazon.awscdk.services.lakeformation

Class CfnDataCellsFilter

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.lakeformation.CfnDataCellsFilter

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:37.414Z")
public class CfnDataCellsFilter
extends CfnResource
implements IInspectable

A CloudFormation `AWS::LakeFormation::DataCellsFilter`.

A structure that represents a data cell filter with column-level, row-level, and/or cell-level security. Data cell filters belong to a specific table in a Data Catalog . During a stack operation, AWS CloudFormation calls the AWS Lake Formation CreateDataCellsFilter API operation to create a DataCellsFilter resource, and calls the DeleteDataCellsFilter API operation to delete it.

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;
 CfnDataCellsFilter cfnDataCellsFilter = CfnDataCellsFilter.Builder.create(this, "MyCfnDataCellsFilter")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDataCellsFilter.Builder A fluent builder for CfnDataCellsFilter.
static interface	CfnDataCellsFilter.ColumnWildcardProperty A wildcard object, consisting of an optional list of excluded column names or indexes.
static interface	CfnDataCellsFilter.RowFilterProperty A PartiQL predicate.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDataCellsFilter(Construct scope, java.lang.String id, CfnDataCellsFilterProps props) Create a new `AWS::LakeFormation::DataCellsFilter`.
protected	CfnDataCellsFilter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataCellsFilter(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.util.List<java.lang.String>	getColumnNames() An array of UTF-8 strings.
java.lang.Object	getColumnWildcard() A wildcard with exclusions.
java.lang.String	getDatabaseName() UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine) .
java.lang.String	getName() UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine) .
java.lang.Object	getRowFilter() A PartiQL predicate.
java.lang.String	getTableCatalogId() Catalog id string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine) .
java.lang.String	getTableName() UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine) .
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setColumnNames(java.util.List<java.lang.String> value) An array of UTF-8 strings.
void	setColumnWildcard(CfnDataCellsFilter.ColumnWildcardProperty value) A wildcard with exclusions.
void	setColumnWildcard(IResolvable value) A wildcard with exclusions.
void	setDatabaseName(java.lang.String value) UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine) .
void	setName(java.lang.String value) UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine) .
void	setRowFilter(CfnDataCellsFilter.RowFilterProperty value) A PartiQL predicate.
void	setRowFilter(IResolvable value) A PartiQL predicate.
void	setTableCatalogId(java.lang.String value) Catalog id string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine) .
void	setTableName(java.lang.String value) UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine) .

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDataCellsFilter

protected CfnDataCellsFilter(software.amazon.jsii.JsiiObjectRef objRef)

CfnDataCellsFilter

protected CfnDataCellsFilter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDataCellsFilter

public CfnDataCellsFilter(Construct scope,
                          java.lang.String id,
                          CfnDataCellsFilterProps props)

Create a new `AWS::LakeFormation::DataCellsFilter`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDatabaseName

public java.lang.String getDatabaseName()

UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine) .

A database in the Data Catalog .

setDatabaseName

public void setDatabaseName(java.lang.String value)

UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine) .

A database in the Data Catalog .

getName

public java.lang.String getName()

UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine) .

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

setName

public void setName(java.lang.String value)

UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine) .

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

getTableCatalogId

public java.lang.String getTableCatalogId()

Catalog id string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine) .

The ID of the catalog to which the table belongs.

setTableCatalogId

public void setTableCatalogId(java.lang.String value)

Catalog id string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine) .

The ID of the catalog to which the table belongs.

getTableName

public java.lang.String getTableName()

UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine) .

A table in the database.

setTableName

public void setTableName(java.lang.String value)

UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine) .

A table in the database.

getColumnNames

public java.util.List<java.lang.String> getColumnNames()

An array of UTF-8 strings.

A list of column names.

setColumnNames

public void setColumnNames(java.util.List<java.lang.String> value)

An array of UTF-8 strings.

A list of column names.

getColumnWildcard

public java.lang.Object getColumnWildcard()

A wildcard with exclusions.

You must specify either a ColumnNames list or the ColumnWildCard .

setColumnWildcard

public void setColumnWildcard(CfnDataCellsFilter.ColumnWildcardProperty value)

A wildcard with exclusions.

You must specify either a ColumnNames list or the ColumnWildCard .

setColumnWildcard

public void setColumnWildcard(IResolvable value)

A wildcard with exclusions.

You must specify either a ColumnNames list or the ColumnWildCard .

getRowFilter

public java.lang.Object getRowFilter()

A PartiQL predicate.

setRowFilter

public void setRowFilter(IResolvable value)

A PartiQL predicate.

setRowFilter

public void setRowFilter(CfnDataCellsFilter.RowFilterProperty value)

A PartiQL predicate.