Class CfnDataCellsFilter

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-22T22:42:53.598Z") @Stability(Stable) 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();
 

See Also:
  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnDataCellsFilterProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.
  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull 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

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource
    • getDatabaseName

      @Stability(Stable) @NotNull public String getDatabaseName()
      UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .
    • setDatabaseName

      @Stability(Stable) public void setDatabaseName(@NotNull String value)
      UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .
    • getName

      @Stability(Stable) @NotNull public String getName()
      UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .
    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .
    • getTableCatalogId

      @Stability(Stable) @NotNull public String getTableCatalogId()
      Catalog id string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .
    • setTableCatalogId

      @Stability(Stable) public void setTableCatalogId(@NotNull String value)
      Catalog id string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .
    • getTableName

      @Stability(Stable) @NotNull public String getTableName()
      UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .
    • setTableName

      @Stability(Stable) public void setTableName(@NotNull String value)
      UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .
    • getColumnNames

      @Stability(Stable) @Nullable public List<String> getColumnNames()
      An array of UTF-8 strings.
    • setColumnNames

      @Stability(Stable) public void setColumnNames(@Nullable List<String> value)
      An array of UTF-8 strings.
    • getColumnWildcard

      @Stability(Stable) @Nullable public Object getColumnWildcard()
      A wildcard with exclusions.
    • setColumnWildcard

      @Stability(Stable) public void setColumnWildcard(@Nullable IResolvable value)
      A wildcard with exclusions.
    • setColumnWildcard

      @Stability(Stable) public void setColumnWildcard(@Nullable CfnDataCellsFilter.ColumnWildcardProperty value)
      A wildcard with exclusions.
    • getRowFilter

      @Stability(Stable) @Nullable public Object getRowFilter()
      A PartiQL predicate.
    • setRowFilter

      @Stability(Stable) public void setRowFilter(@Nullable IResolvable value)
      A PartiQL predicate.
    • setRowFilter

      @Stability(Stable) public void setRowFilter(@Nullable CfnDataCellsFilter.RowFilterProperty value)
      A PartiQL predicate.