Class CfnDataCellsFilter
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
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 ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnDataCellsFilter
.static interface
A wildcard object, consisting of an optional list of excluded column names or indexes.static interface
A PartiQL predicate.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionCfnDataCellsFilter
(Construct scope, String id, CfnDataCellsFilterProps props) Create a newAWS::LakeFormation::DataCellsFilter
.protected
CfnDataCellsFilter
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnDataCellsFilter
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionAn array of UTF-8 strings.A wildcard with exclusions.UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .getName()
UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .A PartiQL predicate.Catalog id string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setColumnNames
(List<String> value) An array of UTF-8 strings.void
setColumnWildcard
(IResolvable value) A wildcard with exclusions.void
A wildcard with exclusions.void
setDatabaseName
(String value) UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .void
UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .void
setRowFilter
(IResolvable value) A PartiQL predicate.void
A PartiQL predicate.void
setTableCatalogId
(String value) Catalog id string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .void
setTableName
(String value) UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .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 software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnDataCellsFilter
protected CfnDataCellsFilter(software.amazon.jsii.JsiiObjectRef objRef) -
CfnDataCellsFilter
protected CfnDataCellsFilter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnDataCellsFilter
@Stability(Stable) public CfnDataCellsFilter(@NotNull Construct scope, @NotNull String id, @NotNull CfnDataCellsFilterProps props) Create a newAWS::LakeFormation::DataCellsFilter
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getDatabaseName
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 .
-
setDatabaseName
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 .
-
getName
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.
-
setName
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.
-
getTableCatalogId
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.
-
setTableCatalogId
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.
-
getTableName
UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .A table in the database.
-
setTableName
UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .A table in the database.
-
getColumnNames
An array of UTF-8 strings.A list of column names.
-
setColumnNames
An array of UTF-8 strings.A list of column names.
-
getColumnWildcard
A wildcard with exclusions.You must specify either a
ColumnNames
list or theColumnWildCard
. -
setColumnWildcard
@Stability(Stable) public void setColumnWildcard(@Nullable CfnDataCellsFilter.ColumnWildcardProperty value) A wildcard with exclusions.You must specify either a
ColumnNames
list or theColumnWildCard
. -
setColumnWildcard
A wildcard with exclusions.You must specify either a
ColumnNames
list or theColumnWildCard
. -
getRowFilter
A PartiQL predicate. -
setRowFilter
A PartiQL predicate. -
setRowFilter
A PartiQL predicate.
-