Skip to main content

Interface: DatasetPrincipalPermissionProps

Defined in: packages/depot-cdk/src/stage-depot-principal-permission.ts:32

Representation of a Dataset Principal Permission configuration

Properties​

accountId?​

readonly optional accountId?: string

Defined in: packages/depot-cdk/src/stage-depot-principal-permission.ts:49

The AWS account ID that the principal belongs to. Defaults to the current account ID


datasetId​

readonly datasetId: string

Defined in: packages/depot-cdk/src/stage-depot-principal-permission.ts:37

The ID of the dataset that the principal will be granted access to


environmentId​

readonly environmentId: string

Defined in: packages/depot-cdk/src/stage-depot-principal-permission.ts:34

The ID of the environment that the dataset belongs to


grantee?​

readonly optional grantee?: IRole

Defined in: packages/depot-cdk/src/stage-depot-principal-permission.ts:62

The role named by principal, when you have it as a construct.

This is used to grant lakeformation:GetDataAccess.

Must be a mutable role. A role imported with Role.fromRoleArn is immutable by default and silently ignores added statements, so pass { mutable: true } or the real construct.


principal​

readonly principal: string

Defined in: packages/depot-cdk/src/stage-depot-principal-permission.ts:46

The AWS IAM principal that will be granted access to the dataset.

The IAM-gateway plane accepts a role, user or account ARN. Asking for either S3 Tables purpose additionally requires a role ARN: neither Lake Formation nor an S3 Tables resource policy accepts a session as a principal, so an assumed-role ARN is refused at synth rather than forwarded.


purposes?​

readonly optional purposes?: DatasetPrincipalPermissionPurposes

Defined in: packages/depot-cdk/src/stage-depot-principal-permission.ts:52

Default​

{ gatewayApi: true }