1. Packages
  2. AWS Native
  3. API Docs
  4. lakeformation
  5. DataCellsFilter

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.lakeformation.DataCellsFilter

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    A resource schema representing a Lake Formation Data Cells Filter.

    Create DataCellsFilter Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DataCellsFilter(name: string, args: DataCellsFilterArgs, opts?: CustomResourceOptions);
    @overload
    def DataCellsFilter(resource_name: str,
                        args: DataCellsFilterArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def DataCellsFilter(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        database_name: Optional[str] = None,
                        table_catalog_id: Optional[str] = None,
                        table_name: Optional[str] = None,
                        column_names: Optional[Sequence[str]] = None,
                        column_wildcard: Optional[DataCellsFilterColumnWildcardArgs] = None,
                        name: Optional[str] = None,
                        row_filter: Optional[DataCellsFilterRowFilterArgs] = None)
    func NewDataCellsFilter(ctx *Context, name string, args DataCellsFilterArgs, opts ...ResourceOption) (*DataCellsFilter, error)
    public DataCellsFilter(string name, DataCellsFilterArgs args, CustomResourceOptions? opts = null)
    public DataCellsFilter(String name, DataCellsFilterArgs args)
    public DataCellsFilter(String name, DataCellsFilterArgs args, CustomResourceOptions options)
    
    type: aws-native:lakeformation:DataCellsFilter
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DataCellsFilterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DataCellsFilterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DataCellsFilterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataCellsFilterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataCellsFilterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const dataCellsFilterResource = new aws_native.lakeformation.DataCellsFilter("dataCellsFilterResource", {
        databaseName: "string",
        tableCatalogId: "string",
        tableName: "string",
        columnNames: ["string"],
        columnWildcard: {
            excludedColumnNames: ["string"],
        },
        name: "string",
        rowFilter: {
            allRowsWildcard: "any",
            filterExpression: "string",
        },
    });
    
    Coming soon!
    

    DataCellsFilter Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The DataCellsFilter resource accepts the following input properties:

    DatabaseName string
    The name of the Database that the Table resides in.
    TableCatalogId string
    The Catalog Id of the Table on which to create a Data Cells Filter.
    TableName string
    The name of the Table to create a Data Cells Filter for.
    ColumnNames List<string>
    A list of columns to be included in this Data Cells Filter.
    ColumnWildcard Pulumi.AwsNative.LakeFormation.Inputs.DataCellsFilterColumnWildcard
    An object representing the Data Cells Filter's Columns. Either Column Names or a Wildcard is required
    Name string
    The desired name of the Data Cells Filter.
    RowFilter Pulumi.AwsNative.LakeFormation.Inputs.DataCellsFilterRowFilter
    An object representing the Data Cells Filter's Row Filter. Either a Filter Expression or a Wildcard is required
    DatabaseName string
    The name of the Database that the Table resides in.
    TableCatalogId string
    The Catalog Id of the Table on which to create a Data Cells Filter.
    TableName string
    The name of the Table to create a Data Cells Filter for.
    ColumnNames []string
    A list of columns to be included in this Data Cells Filter.
    ColumnWildcard DataCellsFilterColumnWildcardArgs
    An object representing the Data Cells Filter's Columns. Either Column Names or a Wildcard is required
    Name string
    The desired name of the Data Cells Filter.
    RowFilter DataCellsFilterRowFilterArgs
    An object representing the Data Cells Filter's Row Filter. Either a Filter Expression or a Wildcard is required
    databaseName String
    The name of the Database that the Table resides in.
    tableCatalogId String
    The Catalog Id of the Table on which to create a Data Cells Filter.
    tableName String
    The name of the Table to create a Data Cells Filter for.
    columnNames List<String>
    A list of columns to be included in this Data Cells Filter.
    columnWildcard DataCellsFilterColumnWildcard
    An object representing the Data Cells Filter's Columns. Either Column Names or a Wildcard is required
    name String
    The desired name of the Data Cells Filter.
    rowFilter DataCellsFilterRowFilter
    An object representing the Data Cells Filter's Row Filter. Either a Filter Expression or a Wildcard is required
    databaseName string
    The name of the Database that the Table resides in.
    tableCatalogId string
    The Catalog Id of the Table on which to create a Data Cells Filter.
    tableName string
    The name of the Table to create a Data Cells Filter for.
    columnNames string[]
    A list of columns to be included in this Data Cells Filter.
    columnWildcard DataCellsFilterColumnWildcard
    An object representing the Data Cells Filter's Columns. Either Column Names or a Wildcard is required
    name string
    The desired name of the Data Cells Filter.
    rowFilter DataCellsFilterRowFilter
    An object representing the Data Cells Filter's Row Filter. Either a Filter Expression or a Wildcard is required
    database_name str
    The name of the Database that the Table resides in.
    table_catalog_id str
    The Catalog Id of the Table on which to create a Data Cells Filter.
    table_name str
    The name of the Table to create a Data Cells Filter for.
    column_names Sequence[str]
    A list of columns to be included in this Data Cells Filter.
    column_wildcard DataCellsFilterColumnWildcardArgs
    An object representing the Data Cells Filter's Columns. Either Column Names or a Wildcard is required
    name str
    The desired name of the Data Cells Filter.
    row_filter DataCellsFilterRowFilterArgs
    An object representing the Data Cells Filter's Row Filter. Either a Filter Expression or a Wildcard is required
    databaseName String
    The name of the Database that the Table resides in.
    tableCatalogId String
    The Catalog Id of the Table on which to create a Data Cells Filter.
    tableName String
    The name of the Table to create a Data Cells Filter for.
    columnNames List<String>
    A list of columns to be included in this Data Cells Filter.
    columnWildcard Property Map
    An object representing the Data Cells Filter's Columns. Either Column Names or a Wildcard is required
    name String
    The desired name of the Data Cells Filter.
    rowFilter Property Map
    An object representing the Data Cells Filter's Row Filter. Either a Filter Expression or a Wildcard is required

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DataCellsFilter resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    DataCellsFilterColumnWildcard, DataCellsFilterColumnWildcardArgs

    ExcludedColumnNames List<string>
    A list of column names to be excluded from the Data Cells Filter.
    ExcludedColumnNames []string
    A list of column names to be excluded from the Data Cells Filter.
    excludedColumnNames List<String>
    A list of column names to be excluded from the Data Cells Filter.
    excludedColumnNames string[]
    A list of column names to be excluded from the Data Cells Filter.
    excluded_column_names Sequence[str]
    A list of column names to be excluded from the Data Cells Filter.
    excludedColumnNames List<String>
    A list of column names to be excluded from the Data Cells Filter.

    DataCellsFilterRowFilter, DataCellsFilterRowFilterArgs

    AllRowsWildcard object
    An empty object representing a row wildcard.
    FilterExpression string
    A PartiQL predicate.
    AllRowsWildcard interface{}
    An empty object representing a row wildcard.
    FilterExpression string
    A PartiQL predicate.
    allRowsWildcard Object
    An empty object representing a row wildcard.
    filterExpression String
    A PartiQL predicate.
    allRowsWildcard any
    An empty object representing a row wildcard.
    filterExpression string
    A PartiQL predicate.
    all_rows_wildcard Any
    An empty object representing a row wildcard.
    filter_expression str
    A PartiQL predicate.
    allRowsWildcard Any
    An empty object representing a row wildcard.
    filterExpression String
    A PartiQL predicate.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi