Permissions
Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Permissions are granted to a principal, in a Data Catalog, relative to a Lake Formation resource, which includes the Data Catalog, databases, tables, LF-tags, and LF-tag policies. For more information, see Security and Access Control to Metadata and Data in Lake Formation. !>WARNING: Lake Formation permissions are not in effect by default within AWS. Using this resource will not secure your data and will result in errors if you do not change the security settings for existing resources and the default security settings for new resources. See Default Behavior and IAMAllowedPrincipals for additional details.
NOTE: In general, the
principalshould NOT be a Lake Formation administrator or the entity (e.g., IAM role) that is running the deployment. Administrators have implicit permissions. These should be managed by granting or not granting administrator rights usingaws.lakeformation.DataLakeSettings, not with this resource.
Default Behavior and IAMAllowedPrincipals
Lake Formation permissions are not in effect by default within AWS. IAMAllowedPrincipals (i.e., IAM_ALLOWED_PRINCIPALS) conflicts with individual Lake Formation permissions (i.e., non-IAMAllowedPrincipals permissions), will cause unexpected behavior, and may result in errors. When using Lake Formation, choose ONE of the following options as they are mutually exclusive:
Use this resource (
aws.lakeformation.Permissions), change the default security settings usingaws.lakeformation.DataLakeSettings, and remove existingIAMAllowedPrincipalspermissionsUse
IAMAllowedPrincipalswithoutaws.lakeformation.PermissionsThis example shows removing theIAMAllowedPrincipalsdefault security settings and making the caller a Lake Formation admin. Sincecreate_database_default_permissionsandcreate_table_default_permissionsare not set in theaws.lakeformation.DataLakeSettingsresource, they are cleared.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const currentCallerIdentity = aws.getCallerIdentity({});
const currentSessionContext = currentCallerIdentity.then(currentCallerIdentity => aws.iam.getSessionContext({
arn: currentCallerIdentity.arn,
}));
const test = new aws.lakeformation.DataLakeSettings("test", {admins: [currentSessionContext.then(currentSessionContext => currentSessionContext.issuerArn)]});import pulumi
import pulumi_aws as aws
current_caller_identity = aws.get_caller_identity()
current_session_context = aws.iam.get_session_context(arn=current_caller_identity.arn)
test = aws.lakeformation.DataLakeSettings("test", admins=[current_session_context.issuer_arn])using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var currentCallerIdentity = Aws.GetCallerIdentity.Invoke();
var currentSessionContext = Aws.Iam.GetSessionContext.Invoke(new()
{
Arn = currentCallerIdentity.Apply(getCallerIdentityResult => getCallerIdentityResult.Arn),
});
var test = new Aws.LakeFormation.DataLakeSettings("test", new()
{
Admins = new[]
{
currentSessionContext.Apply(getSessionContextResult => getSessionContextResult.IssuerArn),
},
});
});package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws"
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/iam"
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/lakeformation"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
currentCallerIdentity, err := aws.GetCallerIdentity(ctx, nil, nil)
if err != nil {
return err
}
currentSessionContext, err := iam.GetSessionContext(ctx, &iam.GetSessionContextArgs{
Arn: currentCallerIdentity.Arn,
}, nil)
if err != nil {
return err
}
_, err = lakeformation.NewDataLakeSettings(ctx, "test", &lakeformation.DataLakeSettingsArgs{
Admins: pulumi.StringArray{
*pulumi.String(currentSessionContext.IssuerArn),
},
})
if err != nil {
return err
}
return nil
})
}package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.AwsFunctions;
import com.pulumi.aws.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetSessionContextArgs;
import com.pulumi.aws.lakeformation.DataLakeSettings;
import com.pulumi.aws.lakeformation.DataLakeSettingsArgs;
import java.util.List;
import java.util.ArrayList;
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) {
final var currentCallerIdentity = AwsFunctions.getCallerIdentity();
final var currentSessionContext = IamFunctions.getSessionContext(GetSessionContextArgs.builder()
.arn(currentCallerIdentity.applyValue(getCallerIdentityResult -> getCallerIdentityResult.arn()))
.build());
var test = new DataLakeSettings("test", DataLakeSettingsArgs.builder()
.admins(currentSessionContext.applyValue(getSessionContextResult -> getSessionContextResult.issuerArn()))
.build());
}
}resources:
test:
type: aws:lakeformation:DataLakeSettings
properties:
admins:
- ${currentSessionContext.issuerArn}
variables:
currentCallerIdentity:
fn::invoke:
Function: aws:getCallerIdentity
Arguments: {}
currentSessionContext:
fn::invoke:
Function: aws:iam:getSessionContext
Arguments:
arn: ${currentCallerIdentity.arn}To remove existing IAMAllowedPrincipals permissions, use the AWS Lake Formation Console or AWS CLI. IAMAllowedPrincipals is a hook to maintain backwards compatibility with AWS Glue. IAMAllowedPrincipals is a pseudo-entity group that acts like a Lake Formation principal. The group includes any IAM users and roles that are allowed access to your Data Catalog resources by your IAM policies. This is Lake Formation's default behavior:
Lake Formation grants
Superpermission toIAMAllowedPrincipalson all existing AWS Glue Data Catalog resources.Lake Formation enables "Use only IAM access control" for new Data Catalog resources. For more details, see Changing the Default Security Settings for Your Data Lake.
Problem Using IAMAllowedPrincipals
AWS does not support combining IAMAllowedPrincipals permissions and non-IAMAllowedPrincipals permissions. Doing so results in unexpected permissions and behaviors. For example, this configuration grants a user SELECT on a column in a table.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const exampleCatalogDatabase = new aws.glue.CatalogDatabase("exampleCatalogDatabase", {name: "sadabate"});
const exampleCatalogTable = new aws.glue.CatalogTable("exampleCatalogTable", {
name: "abelt",
databaseName: aws_glue_catalog_database.test.name,
storageDescriptor: {
columns: [{
name: "event",
type: "string",
}],
},
});
const examplePermissions = new aws.lakeformation.Permissions("examplePermissions", {
permissions: ["SELECT"],
principal: "arn:aws:iam:us-east-1:123456789012:user/SanHolo",
tableWithColumns: {
databaseName: exampleCatalogTable.databaseName,
name: exampleCatalogTable.name,
columnNames: ["event"],
},
});import pulumi
import pulumi_aws as aws
example_catalog_database = aws.glue.CatalogDatabase("exampleCatalogDatabase", name="sadabate")
example_catalog_table = aws.glue.CatalogTable("exampleCatalogTable",
name="abelt",
database_name=aws_glue_catalog_database["test"]["name"],
storage_descriptor=aws.glue.CatalogTableStorageDescriptorArgs(
columns=[aws.glue.CatalogTableStorageDescriptorColumnArgs(
name="event",
type="string",
)],
))
example_permissions = aws.lakeformation.Permissions("examplePermissions",
permissions=["SELECT"],
principal="arn:aws:iam:us-east-1:123456789012:user/SanHolo",
table_with_columns=aws.lakeformation.PermissionsTableWithColumnsArgs(
database_name=example_catalog_table.database_name,
name=example_catalog_table.name,
column_names=["event"],
))using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var exampleCatalogDatabase = new Aws.Glue.CatalogDatabase("exampleCatalogDatabase", new()
{
Name = "sadabate",
});
var exampleCatalogTable = new Aws.Glue.CatalogTable("exampleCatalogTable", new()
{
Name = "abelt",
DatabaseName = aws_glue_catalog_database.Test.Name,
StorageDescriptor = new Aws.Glue.Inputs.CatalogTableStorageDescriptorArgs
{
Columns = new[]
{
new Aws.Glue.Inputs.CatalogTableStorageDescriptorColumnArgs
{
Name = "event",
Type = "string",
},
},
},
});
var examplePermissions = new Aws.LakeFormation.Permissions("examplePermissions", new()
{
PermissionDetails = new[]
{
"SELECT",
},
Principal = "arn:aws:iam:us-east-1:123456789012:user/SanHolo",
TableWithColumns = new Aws.LakeFormation.Inputs.PermissionsTableWithColumnsArgs
{
DatabaseName = exampleCatalogTable.DatabaseName,
Name = exampleCatalogTable.Name,
ColumnNames = new[]
{
"event",
},
},
});
});package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/glue"
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/lakeformation"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := glue.NewCatalogDatabase(ctx, "exampleCatalogDatabase", &glue.CatalogDatabaseArgs{
Name: pulumi.String("sadabate"),
})
if err != nil {
return err
}
exampleCatalogTable, err := glue.NewCatalogTable(ctx, "exampleCatalogTable", &glue.CatalogTableArgs{
Name: pulumi.String("abelt"),
DatabaseName: pulumi.Any(aws_glue_catalog_database.Test.Name),
StorageDescriptor: &glue.CatalogTableStorageDescriptorArgs{
Columns: glue.CatalogTableStorageDescriptorColumnArray{
&glue.CatalogTableStorageDescriptorColumnArgs{
Name: pulumi.String("event"),
Type: pulumi.String("string"),
},
},
},
})
if err != nil {
return err
}
_, err = lakeformation.NewPermissions(ctx, "examplePermissions", &lakeformation.PermissionsArgs{
Permissions: pulumi.StringArray{
pulumi.String("SELECT"),
},
Principal: pulumi.String("arn:aws:iam:us-east-1:123456789012:user/SanHolo"),
TableWithColumns: &lakeformation.PermissionsTableWithColumnsArgs{
DatabaseName: exampleCatalogTable.DatabaseName,
Name: exampleCatalogTable.Name,
ColumnNames: pulumi.StringArray{
pulumi.String("event"),
},
},
})
if err != nil {
return err
}
return nil
})
}package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.glue.CatalogDatabase;
import com.pulumi.aws.glue.CatalogDatabaseArgs;
import com.pulumi.aws.glue.CatalogTable;
import com.pulumi.aws.glue.CatalogTableArgs;
import com.pulumi.aws.glue.inputs.CatalogTableStorageDescriptorArgs;
import com.pulumi.aws.lakeformation.Permissions;
import com.pulumi.aws.lakeformation.PermissionsArgs;
import com.pulumi.aws.lakeformation.inputs.PermissionsTableWithColumnsArgs;
import java.util.List;
import java.util.ArrayList;
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 exampleCatalogDatabase = new CatalogDatabase("exampleCatalogDatabase", CatalogDatabaseArgs.builder()
.name("sadabate")
.build());
var exampleCatalogTable = new CatalogTable("exampleCatalogTable", CatalogTableArgs.builder()
.name("abelt")
.databaseName(aws_glue_catalog_database.test().name())
.storageDescriptor(CatalogTableStorageDescriptorArgs.builder()
.columns(CatalogTableStorageDescriptorColumnArgs.builder()
.name("event")
.type("string")
.build())
.build())
.build());
var examplePermissions = new Permissions("examplePermissions", PermissionsArgs.builder()
.permissions("SELECT")
.principal("arn:aws:iam:us-east-1:123456789012:user/SanHolo")
.tableWithColumns(PermissionsTableWithColumnsArgs.builder()
.databaseName(exampleCatalogTable.databaseName())
.name(exampleCatalogTable.name())
.columnNames("event")
.build())
.build());
}
}resources:
exampleCatalogDatabase:
type: aws:glue:CatalogDatabase
properties:
name: sadabate
exampleCatalogTable:
type: aws:glue:CatalogTable
properties:
name: abelt
databaseName: ${aws_glue_catalog_database.test.name}
storageDescriptor:
columns:
- name: event
type: string
examplePermissions:
type: aws:lakeformation:Permissions
properties:
permissions:
- SELECT
principal: arn:aws:iam:us-east-1:123456789012:user/SanHolo
tableWithColumns:
databaseName: ${exampleCatalogTable.databaseName}
name: ${exampleCatalogTable.name}
columnNames:
- eventThe resulting permissions depend on whether the table had IAMAllowedPrincipals (IAP) permissions or not. | Result With IAP | Result Without IAP | | ---- | ---- | | SELECT column wildcard (i.e., all columns) | SELECT on "event" (as expected) |
Using Lake Formation Permissions
Lake Formation grants implicit permissions to data lake administrators, database creators, and table creators. These implicit permissions cannot be revoked per se. If this resource reads implicit permissions, it will attempt to revoke them, which causes an error when the resource is destroyed. There are two ways to avoid these errors. First, and the way we recommend, is to avoid using this resource with principals that have implicit permissions. A second, error-prone option, is to grant explicit permissions (and permissions_with_grant_option) to "overwrite" a principal's implicit permissions, which you can then revoke with this resource. For more information, see Implicit Lake Formation Permissions. If the principal is also a data lake administrator, AWS grants implicit permissions that can cause errors using this resource. For example, AWS implicitly grants a principal/administrator permissions and permissions_with_grant_option of ALL, ALTER, DELETE, DESCRIBE, DROP, INSERT, and SELECT on a table. If you use this resource to explicitly grant the principal/administrator permissions but not permissions_with_grant_option of ALL, ALTER, DELETE, DESCRIBE, DROP, INSERT, and SELECT on the table, this resource will read the implicit permissions_with_grant_option and attempt to revoke them when the resource is destroyed. Doing so will cause an InvalidInputException: No permissions revoked error because you cannot revoke implicit permissions per se. To workaround this problem, explicitly grant the principal/administrator permissions and permissions_with_grant_option, which can then be revoked. Similarly, granting a principal/administrator permissions on a table with columns and providing column_names, will result in a InvalidInputException: Permissions modification is invalid error because you are narrowing the implicit permissions. Instead, set wildcard to true and remove the column_names.
Example Usage
Grant Permissions For A Lake Formation S3 Resource
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lakeformation.Permissions;
import com.pulumi.aws.lakeformation.PermissionsArgs;
import com.pulumi.aws.lakeformation.inputs.PermissionsDataLocationArgs;
import java.util.List;
import java.util.ArrayList;
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 Permissions("example", PermissionsArgs.builder()
.principal(aws_iam_role.workflow_role().arn())
.permissions("ALL")
.dataLocation(PermissionsDataLocationArgs.builder()
.arn(aws_lakeformation_resource.example().arn())
.build())
.build());
}
}Grant Permissions For A Glue Catalog Database
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lakeformation.Permissions;
import com.pulumi.aws.lakeformation.PermissionsArgs;
import com.pulumi.aws.lakeformation.inputs.PermissionsDatabaseArgs;
import java.util.List;
import java.util.ArrayList;
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 Permissions("example", PermissionsArgs.builder()
.principal(aws_iam_role.workflow_role().arn())
.permissions(
"CREATE_TABLE",
"ALTER",
"DROP")
.database(PermissionsDatabaseArgs.builder()
.name(aws_glue_catalog_database.example().name())
.catalogId("110376042874")
.build())
.build());
}
}Grant Permissions Using Tag-Based Access Control
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lakeformation.Permissions;
import com.pulumi.aws.lakeformation.PermissionsArgs;
import com.pulumi.aws.lakeformation.inputs.PermissionsLfTagPolicyArgs;
import java.util.List;
import java.util.ArrayList;
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 test = new Permissions("test", PermissionsArgs.builder()
.principal(aws_iam_role.sales_role().arn())
.permissions(
"CREATE_TABLE",
"ALTER",
"DROP")
.lfTagPolicy(PermissionsLfTagPolicyArgs.builder()
.resourceType("DATABASE")
.expressions(
PermissionsLfTagPolicyExpressionArgs.builder()
.key("Team")
.values("Sales")
.build(),
PermissionsLfTagPolicyExpressionArgs.builder()
.key("Environment")
.values(
"Dev",
"Production")
.build())
.build())
.build());
}
}Constructors
Properties
Whether the permissions are to be granted for the Data Catalog. Defaults to false.
Configuration block for a database resource. Detailed below.
Configuration block for a data location resource. Detailed below.
Configuration block for an LF-tag resource. Detailed below.
Configuration block for an LF-tag policy resource. Detailed below.
List of permissions granted to the principal. Valid values may include ALL, ALTER, ASSOCIATE, CREATE_DATABASE, CREATE_TABLE, DATA_LOCATION_ACCESS, DELETE, DESCRIBE, DROP, INSERT, and SELECT. For details on each permission, see Lake Formation Permissions Reference.
Subset of permissions which the principal can pass.
Principal to be granted the permissions on the resource. Supported principals include IAM_ALLOWED_PRINCIPALS (see Default Behavior and IAMAllowedPrincipals above), IAM roles, users, groups, SAML groups and users, QuickSight groups, OUs, and organizations as well as AWS account IDs for cross-account permissions. For more information, see Lake Formation Permissions Reference.
Configuration block for a table resource. Detailed below.
Configuration block for a table with columns resource. Detailed below. The following arguments are optional: