aws-cdk-lib.aws_lakeformation.CfnPrincipalPermissionsProps

interface CfnPrincipalPermissionsProps

LanguageType name
.NETAmazon.CDK.AWS.LakeFormation.CfnPrincipalPermissionsProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslakeformation#CfnPrincipalPermissionsProps
Javasoftware.amazon.awscdk.services.lakeformation.CfnPrincipalPermissionsProps
Pythonaws_cdk.aws_lakeformation.CfnPrincipalPermissionsProps
TypeScript aws-cdk-lib » aws_lakeformation » CfnPrincipalPermissionsProps

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 { aws_lakeformation as lakeformation } from 'aws-cdk-lib';

declare const catalog: any;
declare const tableWildcard: any;
const cfnPrincipalPermissionsProps: lakeformation.CfnPrincipalPermissionsProps = {
  permissions: ['permissions'],
  permissionsWithGrantOption: ['permissionsWithGrantOption'],
  principal: {
    dataLakePrincipalIdentifier: 'dataLakePrincipalIdentifier',
  },
  resource: {
    catalog: catalog,
    database: {
      catalogId: 'catalogId',
      name: 'name',
    },
    dataCellsFilter: {
      databaseName: 'databaseName',
      name: 'name',
      tableCatalogId: 'tableCatalogId',
      tableName: 'tableName',
    },
    dataLocation: {
      catalogId: 'catalogId',
      resourceArn: 'resourceArn',
    },
    lfTag: {
      catalogId: 'catalogId',
      tagKey: 'tagKey',
      tagValues: ['tagValues'],
    },
    lfTagPolicy: {
      catalogId: 'catalogId',
      expression: [{
        tagKey: 'tagKey',
        tagValues: ['tagValues'],
      }],
      resourceType: 'resourceType',
    },
    table: {
      catalogId: 'catalogId',
      databaseName: 'databaseName',

      // the properties below are optional
      name: 'name',
      tableWildcard: tableWildcard,
    },
    tableWithColumns: {
      catalogId: 'catalogId',
      databaseName: 'databaseName',
      name: 'name',

      // the properties below are optional
      columnNames: ['columnNames'],
      columnWildcard: {
        excludedColumnNames: ['excludedColumnNames'],
      },
    },
  },

  // the properties below are optional
  catalog: 'catalog',
};

Properties

NameTypeDescription
permissionsstring[]The permissions granted or revoked.
permissionsWithGrantOptionstring[]Indicates the ability to grant permissions (as a subset of permissions granted).
principalIResolvable | DataLakePrincipalPropertyThe principal to be granted a permission.
resourceIResolvable | ResourcePropertyThe resource to be granted or revoked permissions.
catalog?stringThe identifier for the Data Catalog .

permissions

Type: string[]

The permissions granted or revoked.


permissionsWithGrantOption

Type: string[]

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


principal

Type: IResolvable | DataLakePrincipalProperty

The principal to be granted a permission.


resource

Type: IResolvable | ResourceProperty

The resource to be granted or revoked permissions.


catalog?

Type: string (optional)

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.