Package com.pulumi.aws.lakeformation
Class DataCellsFilter
- java.lang.Object
-
- com.pulumi.resources.Resource
-
- com.pulumi.resources.CustomResource
-
- com.pulumi.aws.lakeformation.DataCellsFilter
-
public class DataCellsFilter extends com.pulumi.resources.CustomResourceResource for managing an AWS Lake Formation Data Cells Filter. ## Example Usage ### Basic Usage
### Filter with Excluded Columns Only (No Row Filter) When excluding columns without a row filter, you must include `allRowsWildcard {}`:package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.lakeformation.DataCellsFilter; import com.pulumi.aws.lakeformation.DataCellsFilterArgs; import com.pulumi.aws.lakeformation.inputs.DataCellsFilterTableDataArgs; import com.pulumi.aws.lakeformation.inputs.DataCellsFilterTableDataRowFilterArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new DataCellsFilter("example", DataCellsFilterArgs.builder() .tableData(DataCellsFilterTableDataArgs.builder() .rowFilter(DataCellsFilterTableDataRowFilterArgs.builder() .filterExpression("my_column='example'") .build()) .databaseName(exampleAwsGlueCatalogDatabase.name()) .name("example") .tableCatalogId(current.accountId()) .tableName(exampleAwsGlueCatalogTable.name()) .columnNames("my_column") .build()) .build()); } }
### Filter with Row Filter and Excluded Columnspackage generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.lakeformation.DataCellsFilter; import com.pulumi.aws.lakeformation.DataCellsFilterArgs; import com.pulumi.aws.lakeformation.inputs.DataCellsFilterTableDataArgs; import com.pulumi.aws.lakeformation.inputs.DataCellsFilterTableDataColumnWildcardArgs; import com.pulumi.aws.lakeformation.inputs.DataCellsFilterTableDataRowFilterArgs; import com.pulumi.aws.lakeformation.inputs.DataCellsFilterTableDataRowFilterAllRowsWildcardArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var excludedColumns = new DataCellsFilter("excludedColumns", DataCellsFilterArgs.builder() .tableData(DataCellsFilterTableDataArgs.builder() .columnWildcard(DataCellsFilterTableDataColumnWildcardArgs.builder() .excludedColumnNames( "ssn", "credit_card") .build()) .rowFilter(DataCellsFilterTableDataRowFilterArgs.builder() .allRowsWildcard(DataCellsFilterTableDataRowFilterAllRowsWildcardArgs.builder() .build()) .build()) .databaseName(example.name()) .name("exclude-pii") .tableCatalogId(current.accountId()) .tableName(exampleAwsGlueCatalogTable.name()) .build()) .build()); } }
### Filter with Row Filter Only (All Columns Included) To include all columns with a row filter, set `excludedColumnNames` to an empty list:package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.lakeformation.DataCellsFilter; import com.pulumi.aws.lakeformation.DataCellsFilterArgs; import com.pulumi.aws.lakeformation.inputs.DataCellsFilterTableDataArgs; import com.pulumi.aws.lakeformation.inputs.DataCellsFilterTableDataColumnWildcardArgs; import com.pulumi.aws.lakeformation.inputs.DataCellsFilterTableDataRowFilterArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var rowAndColumn = new DataCellsFilter("rowAndColumn", DataCellsFilterArgs.builder() .tableData(DataCellsFilterTableDataArgs.builder() .columnWildcard(DataCellsFilterTableDataColumnWildcardArgs.builder() .excludedColumnNames( "salary", "bonus") .build()) .rowFilter(DataCellsFilterTableDataRowFilterArgs.builder() .filterExpression("department = 'Marketing'") .build()) .databaseName(example.name()) .name("marketing-filtered") .tableCatalogId(current.accountId()) .tableName(exampleAwsGlueCatalogTable.name()) .build()) .build()); } }
## Import Using `pulumi import`, import Lake Formation Data Cells Filter using the `databaseName`, `name`, `tableCatalogId`, and `tableName` separated by `,`. For example: ```sh $ pulumi import aws:lakeformation/dataCellsFilter:DataCellsFilter example database_name,name,table_catalog_id,table_name ```package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.lakeformation.DataCellsFilter; import com.pulumi.aws.lakeformation.DataCellsFilterArgs; import com.pulumi.aws.lakeformation.inputs.DataCellsFilterTableDataArgs; import com.pulumi.aws.lakeformation.inputs.DataCellsFilterTableDataColumnWildcardArgs; import com.pulumi.aws.lakeformation.inputs.DataCellsFilterTableDataRowFilterArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var rowOnly = new DataCellsFilter("rowOnly", DataCellsFilterArgs.builder() .tableData(DataCellsFilterTableDataArgs.builder() .columnWildcard(DataCellsFilterTableDataColumnWildcardArgs.builder() .excludedColumnNames() .build()) .rowFilter(DataCellsFilterTableDataRowFilterArgs.builder() .filterExpression("region = 'US-WEST'") .build()) .databaseName(example.name()) .name("regional-filter") .tableCatalogId(current.accountId()) .tableName(exampleAwsGlueCatalogTable.name()) .build()) .build()); } }
-
-
Constructor Summary
Constructors Constructor Description DataCellsFilter(java.lang.String name)DataCellsFilter(java.lang.String name, DataCellsFilterArgs args)DataCellsFilter(java.lang.String name, DataCellsFilterArgs args, com.pulumi.resources.CustomResourceOptions options)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DataCellsFilterget(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DataCellsFilterState state, com.pulumi.resources.CustomResourceOptions options)Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.com.pulumi.core.Output<java.lang.String>region()com.pulumi.core.Output<DataCellsFilterTableData>tableData()com.pulumi.core.Output<java.util.Optional<DataCellsFilterTimeouts>>timeouts()
-
-
-
Constructor Detail
-
DataCellsFilter
public DataCellsFilter(java.lang.String name)
- Parameters:
name- The _unique_ name of the resulting resource.
-
DataCellsFilter
public DataCellsFilter(java.lang.String name, DataCellsFilterArgs args)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.
-
DataCellsFilter
public DataCellsFilter(java.lang.String name, DataCellsFilterArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.options- A bag of options that control this resource's behavior.
-
-
Method Detail
-
region
public com.pulumi.core.Output<java.lang.String> region()
- Returns:
- Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
-
tableData
public com.pulumi.core.Output<DataCellsFilterTableData> tableData()
- Returns:
- Information about the data cells filter. See Table Data below for details.
-
timeouts
public com.pulumi.core.Output<java.util.Optional<DataCellsFilterTimeouts>> timeouts()
-
get
public static DataCellsFilter get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, @Nullable DataCellsFilterState state, @Nullable com.pulumi.resources.CustomResourceOptions options)
Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.- Parameters:
name- The _unique_ name of the resulting resource.id- The _unique_ provider ID of the resource to lookup.state-options- Optional settings to control the behavior of the CustomResource.
-
-