Package software.amazon.awscdk.services.lakeformation

Interface CfnPrincipalPermissionsProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPrincipalPermissionsProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:25:01.457Z")
@Stability(Stable)
public interface CfnPrincipalPermissionsProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPrincipalPermissions.

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;
 CfnPrincipalPermissionsProps cfnPrincipalPermissionsProps = CfnPrincipalPermissionsProps.builder()
         .permissions(List.of("permissions"))
         .permissionsWithGrantOption(List.of("permissionsWithGrantOption"))
         .principal(DataLakePrincipalProperty.builder()
                 .dataLakePrincipalIdentifier("dataLakePrincipalIdentifier")
                 .build())
         .resource(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())
         // the properties below are optional
         .catalog("catalog")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPrincipalPermissionsProps.Builder	builder()
default String	getCatalog()	The identifier for the Data Catalog .
List<String>	getPermissions()	The permissions granted or revoked.
List<String>	getPermissionsWithGrantOption()	Indicates the ability to grant permissions (as a subset of permissions granted).
Object	getPrincipal()	The principal to be granted a permission.
Object	getResource()	The resource to be granted or revoked permissions.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPermissions

@Stability(Stable)
@NotNull
List<String> getPermissions()

The permissions granted or revoked.

See Also:

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

getPermissionsWithGrantOption

@Stability(Stable)
@NotNull
List<String> getPermissionsWithGrantOption()

Indicates the ability to grant permissions (as a subset of permissions granted).

See Also:

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

getPrincipal

@Stability(Stable)
@NotNull
Object getPrincipal()

The principal to be granted a permission.

See Also:

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

getResource

@Stability(Stable)
@NotNull
Object getResource()

The resource to be granted or revoked permissions.

See Also:

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

getCatalog

@Stability(Stable)
@Nullable
default String 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 Lake Formation environment.

See Also:

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

builder

@Stability(Stable)
static CfnPrincipalPermissionsProps.Builder builder()

Returns:

a CfnPrincipalPermissionsProps.Builder of CfnPrincipalPermissionsProps