Skip to content
LocalStack DocsLocalStack DocsDocs
Get Started for Free

Lake Formation

Introduction

Section titled “Introduction”

Lake Formation is a managed service that allows users to build, secure, and manage data lakes. Lake Formation allows users to define and enforce fine-grained access controls, manage metadata, and discover and share data across multiple data sources.

LocalStack allows you to use the Lake Formation APIs in your local environment to register resources, grant permissions, and list resources and permissions. The supported APIs are available on our API Coverage section, which provides information on the extent of Lake Formation’s integration with LocalStack.

Getting started

Section titled “Getting started”

This guide is designed for users new to Lake Formation and assumes basic knowledge of the AWS CLI and our lstk aws command.

Start your LocalStack container using your preferred method. We will demonstrate how to register an S3 bucket as a resource in Lake Formation, grant permissions to a user, and list the resources and permissions.

Register the resource

Section titled “Register the resource”

Create a new S3 bucket named test-bucket using the mb command:

Terminal window
lstk aws s3 mb s3://test-bucket

You can now register the S3 bucket as a resource in Lake Formation using the RegisterResource API. Create a file named input.json with the following content:

{
    "ResourceArn": "arn:aws:s3:::test-bucket",
    "UseServiceLinkedRole": true
}

Run the following command to register the resource:

Terminal window
lstk aws lakeformation register-resource \
    --cli-input-json file://input.json

List resources

Section titled “List resources”

You can list the registered resources using the ListResources API. Execute the following command to list the resources:

Terminal window
lstk aws lakeformation list-resources
Output
{
    "ResourceInfoList": [
        {
            "ResourceArn": "arn:aws:s3:::test-bucket",
            "LastModified": "2024-07-11T23:27:30.699312+05:30"
        }
    ]
}

Grant permissions

Section titled “Grant permissions”

You can grant permissions to a user or group using the GrantPermissions API. Create a file named permissions.json with the following content:

{
    "CatalogId": "000000000000",
    "Principal": {
        "DataLakePrincipalIdentifier": "arn:aws:iam::000000000000:user/lf-developer"
    },
    "Resource": {
        "Table": {
            "CatalogId": "000000000000",
            "DatabaseName": "tpc",
            "TableWildcard": {}
        }
    },
    "Permissions": [
        "SELECT"
    ],
    "PermissionsWithGrantOption": []
}

Run the following command to grant permissions:

Terminal window
lstk aws lakeformation grant-permissions \
    --cli-input-json file://check.json

List permissions

Section titled “List permissions”

You can list the permissions granted to a user or group using the ListPermissions API. Execute the following command to list the permissions:

Terminal window
lstk aws lakeformation list-permissions

API Coverage

Section titled “API Coverage”

9 of 61 operations implemented

Available from the Ultimate plan. Licensing details

Find an API

Search the full operation list, then sort the table to compare current support.

Loading operations…

Verified on Kubernetes
Loading operations…
Complete static API list All 61 operations and their current support status
OperationStatus
AddLFTagsToResourceNot implemented
AssumeDecoratedRoleWithSAMLNot implemented
BatchGrantPermissionsNot implemented
BatchRevokePermissionsNot implemented
CancelTransactionNot implemented
CommitTransactionNot implemented
CreateDataCellsFilterNot implemented
CreateLFTagNot implemented
CreateLFTagExpressionNot implemented
CreateLakeFormationIdentityCenterConfigurationNot implemented
CreateLakeFormationOptInNot implemented
DeleteDataCellsFilterNot implemented
DeleteLFTagNot implemented
DeleteLFTagExpressionNot implemented
DeleteLakeFormationIdentityCenterConfigurationNot implemented
DeleteLakeFormationOptInNot implemented
DeleteObjectsOnCancelNot implemented
DeregisterResourceImplemented
DescribeLakeFormationIdentityCenterConfigurationNot implemented
DescribeResourceImplemented
DescribeTransactionNot implemented
ExtendTransactionNot implemented
GetDataCellsFilterNot implemented
GetDataLakePrincipalNot implemented
GetDataLakeSettingsImplemented
GetEffectivePermissionsForPathNot implemented
GetLFTagNot implemented
GetLFTagExpressionNot implemented
GetQueryStateNot implemented
GetQueryStatisticsNot implemented
GetResourceLFTagsNot implemented
GetTableObjectsNot implemented
GetTemporaryDataLocationCredentialsNot implemented
GetTemporaryGluePartitionCredentialsNot implemented
GetTemporaryGlueTableCredentialsNot implemented
GetWorkUnitResultsNot implemented
GetWorkUnitsNot implemented
GrantPermissionsImplemented
ListDataCellsFilterNot implemented
ListLFTagExpressionsNot implemented
ListLFTagsNot implemented
ListLakeFormationOptInsNot implemented
ListPermissionsImplemented
ListResourcesImplemented
ListTableStorageOptimizersNot implemented
ListTransactionsNot implemented
PutDataLakeSettingsImplemented
RegisterResourceImplemented
RemoveLFTagsFromResourceNot implemented
RevokePermissionsImplemented
SearchDatabasesByLFTagsNot implemented
SearchTablesByLFTagsNot implemented
StartQueryPlanningNot implemented
StartTransactionNot implemented
UpdateDataCellsFilterNot implemented
UpdateLFTagNot implemented
UpdateLFTagExpressionNot implemented
UpdateLakeFormationIdentityCenterConfigurationNot implemented
UpdateResourceNot implemented
UpdateTableObjectsNot implemented
UpdateTableStorageOptimizerNot implemented
Was this page helpful?