Package software.amazon.awscdk.services.lakeformation

Interface CfnPrincipalPermissions.ResourceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPrincipalPermissions.ResourceProperty.Jsii$Proxy

Enclosing class:

CfnPrincipalPermissions

@Stability(Stable)
public static interface CfnPrincipalPermissions.ResourceProperty
extends software.amazon.jsii.JsiiSerializable

A structure for the resource.

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 catalog;
 Object tableWildcard;
 ResourceProperty resourceProperty = ResourceProperty.builder()
         .catalog(catalog)
         .database(DatabaseResourceProperty.builder()
                 .catalogId("catalogId")
                 .name("name")
                 .build())
         .dataCellsFilter(DataCellsFilterResourceProperty.builder()
                 .databaseName("databaseName")
                 .name("name")
                 .tableCatalogId("tableCatalogId")
                 .tableName("tableName")
                 .build())
         .dataLocation(DataLocationResourceProperty.builder()
                 .catalogId("catalogId")
                 .resourceArn("resourceArn")
                 .build())
         .lfTag(LFTagKeyResourceProperty.builder()
                 .catalogId("catalogId")
                 .tagKey("tagKey")
                 .tagValues(List.of("tagValues"))
                 .build())
         .lfTagPolicy(LFTagPolicyResourceProperty.builder()
                 .catalogId("catalogId")
                 .expression(List.of(LFTagProperty.builder()
                         .tagKey("tagKey")
                         .tagValues(List.of("tagValues"))
                         .build()))
                 .resourceType("resourceType")
                 .build())
         .table(TableResourceProperty.builder()
                 .catalogId("catalogId")
                 .databaseName("databaseName")
                 // the properties below are optional
                 .name("name")
                 .tableWildcard(tableWildcard)
                 .build())
         .tableWithColumns(TableWithColumnsResourceProperty.builder()
                 .catalogId("catalogId")
                 .databaseName("databaseName")
                 .name("name")
                 // the properties below are optional
                 .columnNames(List.of("columnNames"))
                 .columnWildcard(ColumnWildcardProperty.builder()
                         .excludedColumnNames(List.of("excludedColumnNames"))
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPrincipalPermissions.ResourceProperty.Builder	A builder for CfnPrincipalPermissions.ResourceProperty
static final class	CfnPrincipalPermissions.ResourceProperty.Jsii$Proxy	An implementation for CfnPrincipalPermissions.ResourceProperty

Method Summary

Modifier and Type	Method	Description
static CfnPrincipalPermissions.ResourceProperty.Builder	builder()
default Object	getCatalog()	The identifier for the Data Catalog.
default Object	getDatabase()	The database for the resource.
default Object	getDataCellsFilter()	A data cell filter.
default Object	getDataLocation()	The location of an Amazon S3 path where permissions are granted or revoked.
default Object	getLfTag()	The LF-tag key and values attached to a resource.
default Object	getLfTagPolicy()	A list of LF-tag conditions that define a resource's LF-tag policy.
default Object	getTable()	The table for the resource.
default Object	getTableWithColumns()	The table with columns for the resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCatalog

@Stability(Stable)
@Nullable
default Object getCatalog()

The identifier for the Data Catalog.

By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-catalog

getDatabase

@Stability(Stable)
@Nullable
default Object getDatabase()

The database for the resource.

Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-database

getDataCellsFilter

@Stability(Stable)
@Nullable
default Object getDataCellsFilter()

A data cell filter.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-datacellsfilter

getDataLocation

@Stability(Stable)
@Nullable
default Object getDataLocation()

The location of an Amazon S3 path where permissions are granted or revoked.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-datalocation

getLfTag

@Stability(Stable)
@Nullable
default Object getLfTag()

The LF-tag key and values attached to a resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-lftag

getLfTagPolicy

@Stability(Stable)
@Nullable
default Object getLfTagPolicy()

A list of LF-tag conditions that define a resource's LF-tag policy.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-lftagpolicy

getTable

@Stability(Stable)
@Nullable
default Object getTable()

The table for the resource.

A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-table

getTableWithColumns

@Stability(Stable)
@Nullable
default Object getTableWithColumns()

The table with columns for the resource.

A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-tablewithcolumns

builder

@Stability(Stable)
static CfnPrincipalPermissions.ResourceProperty.Builder builder()

Returns:

a CfnPrincipalPermissions.ResourceProperty.Builder of CfnPrincipalPermissions.ResourceProperty