@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:37.414Z") public class CfnDataCellsFilter extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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) .
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnDataCellsFilter(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDataCellsFilter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnDataCellsFilter(Construct scope, java.lang.String id, CfnDataCellsFilterProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getDatabaseName()
A database in the Data Catalog .
public void setDatabaseName(java.lang.String value)
A database in the Data Catalog .
public java.lang.String getName()
The name given by the user to the data filter cell.
public void setName(java.lang.String value)
The name given by the user to the data filter cell.
public java.lang.String getTableCatalogId()
The ID of the catalog to which the table belongs.
public void setTableCatalogId(java.lang.String value)
The ID of the catalog to which the table belongs.
public java.lang.String getTableName()
A table in the database.
public void setTableName(java.lang.String value)
A table in the database.
public java.util.List<java.lang.String> getColumnNames()
A list of column names.
public void setColumnNames(java.util.List<java.lang.String> value)
A list of column names.
public java.lang.Object getColumnWildcard()
You must specify either a ColumnNames
list or the ColumnWildCard
.
public void setColumnWildcard(CfnDataCellsFilter.ColumnWildcardProperty value)
You must specify either a ColumnNames
list or the ColumnWildCard
.
public void setColumnWildcard(IResolvable value)
You must specify either a ColumnNames
list or the ColumnWildCard
.
public java.lang.Object getRowFilter()
public void setRowFilter(IResolvable value)
public void setRowFilter(CfnDataCellsFilter.RowFilterProperty value)