Permissions class
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 principal should 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 using aws.lakeformation.DataLakeSettings, not with this resource.
Example Usage
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 existingIAMAllowedPrincipalspermissions - Use
IAMAllowedPrincipalswithoutaws.lakeformation.Permissions
This example shows removing the IAMAllowedPrincipals default security settings and making the caller a Lake Formation admin. Since createDatabaseDefaultPermissions and createTableDefaultPermissions are not set in the aws.lakeformation.DataLakeSettings resource, they are cleared.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const current = aws.getCallerIdentity({});
const currentGetSessionContext = current.then(current => aws.iam.getSessionContext({
arn: current.arn,
}));
const test = new aws.lakeformation.DataLakeSettings("test", {admins: [currentGetSessionContext.then(currentGetSessionContext => currentGetSessionContext.issuerArn)]});
import pulumi
import pulumi_aws as aws
current = aws.get_caller_identity()
current_get_session_context = aws.iam.get_session_context(arn=current.arn)
test = aws.lakeformation.DataLakeSettings("test", admins=[current_get_session_context.issuer_arn])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var current = Aws.GetCallerIdentity.Invoke();
var currentGetSessionContext = Aws.Iam.GetSessionContext.Invoke(new()
{
Arn = current.Apply(getCallerIdentityResult => getCallerIdentityResult.Arn),
});
var test = new Aws.LakeFormation.DataLakeSettings("test", new()
{
Admins = new[]
{
currentGetSessionContext.Apply(getSessionContextResult => getSessionContextResult.IssuerArn),
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/iam"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/lakeformation"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
current, err := aws.GetCallerIdentity(ctx, &aws.GetCallerIdentityArgs{}, nil)
if err != nil {
return err
}
currentGetSessionContext, err := iam.GetSessionContext(ctx, &iam.GetSessionContextArgs{
Arn: current.Arn,
}, nil)
if err != nil {
return err
}
_, err = lakeformation.NewDataLakeSettings(ctx, "test", &lakeformation.DataLakeSettingsArgs{
Admins: pulumi.StringArray{
pulumi.String(currentGetSessionContext.IssuerArn),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_getcalleridentity" "current" {
}
data "aws_iam_getsessioncontext" "currentGetSessionContext" {
arn = data.aws_getcalleridentity.current.arn
}
resource "aws_lakeformation_datalakesettings" "test" {
admins = [data.aws_iam_getsessioncontext.currentGetSessionContext.issuer_arn]
}
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.inputs.GetCallerIdentityArgs;
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.ArrayList;
import java.util.Arrays;
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 current = AwsFunctions.getCallerIdentity(GetCallerIdentityArgs.builder()
.build());
final var currentGetSessionContext = IamFunctions.getSessionContext(GetSessionContextArgs.builder()
.arn(current.arn())
.build());
var test = new DataLakeSettings("test", DataLakeSettingsArgs.builder()
.admins(currentGetSessionContext.issuerArn())
.build());
}
}
resources:
test:
type: aws:lakeformation:DataLakeSettings
properties:
admins:
- ${currentGetSessionContext.issuerArn}
variables:
current:
fn::invoke:
function: aws:getCallerIdentity
arguments: {}
currentGetSessionContext:
fn::invoke:
function: aws:iam:getSessionContext
arguments:
arn: ${current.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 example = new aws.glue.CatalogDatabase("example", {name: "sadabate"});
const exampleCatalogTable = new aws.glue.CatalogTable("example", {
storageDescriptor: {
columns: [{
name: "event",
type: "string",
}],
},
name: "abelt",
databaseName: test.name,
});
const examplePermissions = new aws.lakeformation.Permissions("example", {
tableWithColumns: {
databaseName: exampleCatalogTable.databaseName,
name: exampleCatalogTable.name,
columnNames: ["event"],
},
permissions: ["SELECT"],
principal: "arn:aws:iam:us-east-1:123456789012:user/SanHolo",
});
import pulumi
import pulumi_aws as aws
example = aws.glue.CatalogDatabase("example", name="sadabate")
example_catalog_table = aws.glue.CatalogTable("example",
storage_descriptor={
"columns": [{
"name": "event",
"type": "string",
}],
},
name="abelt",
database_name=test["name"])
example_permissions = aws.lakeformation.Permissions("example",
table_with_columns={
"database_name": example_catalog_table.database_name,
"name": example_catalog_table.name,
"column_names": ["event"],
},
permissions=["SELECT"],
principal="arn:aws:iam:us-east-1:123456789012:user/SanHolo")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Glue.CatalogDatabase("example", new()
{
Name = "sadabate",
});
var exampleCatalogTable = new Aws.Glue.CatalogTable("example", new()
{
StorageDescriptor = new Aws.Glue.Inputs.CatalogTableStorageDescriptorArgs
{
Columns = new[]
{
new Aws.Glue.Inputs.CatalogTableStorageDescriptorColumnArgs
{
Name = "event",
Type = "string",
},
},
},
Name = "abelt",
DatabaseName = test.Name,
});
var examplePermissions = new Aws.LakeFormation.Permissions("example", new()
{
TableWithColumns = new Aws.LakeFormation.Inputs.PermissionsTableWithColumnsArgs
{
DatabaseName = exampleCatalogTable.DatabaseName,
Name = exampleCatalogTable.Name,
ColumnNames = new[]
{
"event",
},
},
PermissionDetails = new[]
{
"SELECT",
},
Principal = "arn:aws:iam:us-east-1:123456789012:user/SanHolo",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/glue"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/lakeformation"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := glue.NewCatalogDatabase(ctx, "example", &glue.CatalogDatabaseArgs{
Name: pulumi.String("sadabate"),
})
if err != nil {
return err
}
exampleCatalogTable, err := glue.NewCatalogTable(ctx, "example", &glue.CatalogTableArgs{
StorageDescriptor: &glue.CatalogTableStorageDescriptorArgs{
Columns: glue.CatalogTableStorageDescriptorColumnArray{
&glue.CatalogTableStorageDescriptorColumnArgs{
Name: pulumi.String("event"),
Type: pulumi.String("string"),
},
},
},
Name: pulumi.String("abelt"),
DatabaseName: pulumi.Any(test.Name),
})
if err != nil {
return err
}
_, err = lakeformation.NewPermissions(ctx, "example", &lakeformation.PermissionsArgs{
TableWithColumns: &lakeformation.PermissionsTableWithColumnsArgs{
DatabaseName: exampleCatalogTable.DatabaseName,
Name: exampleCatalogTable.Name,
ColumnNames: pulumi.StringArray{
pulumi.String("event"),
},
},
Permissions: pulumi.StringArray{
pulumi.String("SELECT"),
},
Principal: pulumi.String("arn:aws:iam:us-east-1:123456789012:user/SanHolo"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_glue_catalogdatabase" "example" {
name = "sadabate"
}
resource "aws_glue_catalogtable" "example" {
storage_descriptor = {
columns = [{
"name" = "event"
"type" = "string"
}]
}
name = "abelt"
database_name = test.name
}
resource "aws_lakeformation_permissions" "example" {
table_with_columns = {
database_name = aws_glue_catalogtable.example.database_name
name = aws_glue_catalogtable.example.name
column_names = ["event"]
}
permissions = ["SELECT"]
principal = "arn:aws:iam:us-east-1:123456789012:user/SanHolo"
}
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.glue.inputs.CatalogTableStorageDescriptorColumnArgs;
import com.pulumi.aws.lakeformation.Permissions;
import com.pulumi.aws.lakeformation.PermissionsArgs;
import com.pulumi.aws.lakeformation.inputs.PermissionsTableWithColumnsArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 CatalogDatabase("example", CatalogDatabaseArgs.builder()
.name("sadabate")
.build());
var exampleCatalogTable = new CatalogTable("exampleCatalogTable", CatalogTableArgs.builder()
.storageDescriptor(CatalogTableStorageDescriptorArgs.builder()
.columns(CatalogTableStorageDescriptorColumnArgs.builder()
.name("event")
.type("string")
.build())
.build())
.name("abelt")
.databaseName(test.name())
.build());
var examplePermissions = new Permissions("examplePermissions", PermissionsArgs.builder()
.tableWithColumns(PermissionsTableWithColumnsArgs.builder()
.databaseName(exampleCatalogTable.databaseName())
.name(exampleCatalogTable.name())
.columnNames("event")
.build())
.permissions("SELECT")
.principal("arn:aws:iam:us-east-1:123456789012:user/SanHolo")
.build());
}
}
resources:
example:
type: aws:glue:CatalogDatabase
properties:
name: sadabate
exampleCatalogTable:
type: aws:glue:CatalogTable
name: example
properties:
storageDescriptor:
columns:
- name: event
type: string
name: abelt
databaseName: ${test.name}
examplePermissions:
type: aws:lakeformation:Permissions
name: example
properties:
tableWithColumns:
databaseName: ${exampleCatalogTable.databaseName}
name: ${exampleCatalogTable.name}
columnNames:
- event
permissions:
- SELECT
principal: arn:aws:iam:us-east-1:123456789012:user/SanHolo
The 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) |
ALLIAMPrincipals group
AllIAMPrincipals is a pseudo-entity group that acts like a Lake Formation principal. The group includes all IAMs in the account that is defined.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.lakeformation.Permissions("example", {
tableWithColumns: {
databaseName: exampleAwsGlueCatalogTable.databaseName,
name: exampleAwsGlueCatalogTable.name,
columnNames: ["event"],
},
permissions: ["SELECT"],
principal: "123456789012:IAMPrincipals",
});
import pulumi
import pulumi_aws as aws
example = aws.lakeformation.Permissions("example",
table_with_columns={
"database_name": example_aws_glue_catalog_table["databaseName"],
"name": example_aws_glue_catalog_table["name"],
"column_names": ["event"],
},
permissions=["SELECT"],
principal="123456789012:IAMPrincipals")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.LakeFormation.Permissions("example", new()
{
TableWithColumns = new Aws.LakeFormation.Inputs.PermissionsTableWithColumnsArgs
{
DatabaseName = exampleAwsGlueCatalogTable.DatabaseName,
Name = exampleAwsGlueCatalogTable.Name,
ColumnNames = new[]
{
"event",
},
},
PermissionDetails = new[]
{
"SELECT",
},
Principal = "123456789012:IAMPrincipals",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/lakeformation"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := lakeformation.NewPermissions(ctx, "example", &lakeformation.PermissionsArgs{
TableWithColumns: &lakeformation.PermissionsTableWithColumnsArgs{
DatabaseName: pulumi.Any(exampleAwsGlueCatalogTable.DatabaseName),
Name: pulumi.Any(exampleAwsGlueCatalogTable.Name),
ColumnNames: pulumi.StringArray{
pulumi.String("event"),
},
},
Permissions: pulumi.StringArray{
pulumi.String("SELECT"),
},
Principal: pulumi.String("123456789012:IAMPrincipals"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_lakeformation_permissions" "example" {
table_with_columns = {
database_name = exampleAwsGlueCatalogTable.databaseName
name = exampleAwsGlueCatalogTable.name
column_names = ["event"]
}
permissions = ["SELECT"]
principal = "123456789012:IAMPrincipals"
}
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.PermissionsTableWithColumnsArgs;
import java.util.ArrayList;
import java.util.Arrays;
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()
.tableWithColumns(PermissionsTableWithColumnsArgs.builder()
.databaseName(exampleAwsGlueCatalogTable.databaseName())
.name(exampleAwsGlueCatalogTable.name())
.columnNames("event")
.build())
.permissions("SELECT")
.principal("123456789012:IAMPrincipals")
.build());
}
}
resources:
example:
type: aws:lakeformation:Permissions
properties:
tableWithColumns:
databaseName: ${exampleAwsGlueCatalogTable.databaseName}
name: ${exampleAwsGlueCatalogTable.name}
columnNames:
- event
permissions:
- SELECT
principal: 123456789012:IAMPrincipals
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 permissionsWithGrantOption) 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 permissionsWithGrantOption 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 permissionsWithGrantOption of ALL, ALTER, DELETE, DESCRIBE, DROP, INSERT, and SELECT on the table, this resource will read the implicit permissionsWithGrantOption 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 permissionsWithGrantOption, which can then be revoked. Similarly, granting a principal/administrator permissions on a table with columns and providing columnNames, 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 columnNames.
Grant Permissions For A Lake Formation S3 Resource
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.lakeformation.Permissions("example", {
dataLocation: {
arn: exampleAwsLakeformationResource.arn,
},
principal: workflowRole.arn,
permissions: ["DATA_LOCATION_ACCESS"],
});
import pulumi
import pulumi_aws as aws
example = aws.lakeformation.Permissions("example",
data_location={
"arn": example_aws_lakeformation_resource["arn"],
},
principal=workflow_role["arn"],
permissions=["DATA_LOCATION_ACCESS"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.LakeFormation.Permissions("example", new()
{
DataLocation = new Aws.LakeFormation.Inputs.PermissionsDataLocationArgs
{
Arn = exampleAwsLakeformationResource.Arn,
},
Principal = workflowRole.Arn,
PermissionDetails = new[]
{
"DATA_LOCATION_ACCESS",
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/lakeformation"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := lakeformation.NewPermissions(ctx, "example", &lakeformation.PermissionsArgs{
DataLocation: &lakeformation.PermissionsDataLocationArgs{
Arn: pulumi.Any(exampleAwsLakeformationResource.Arn),
},
Principal: pulumi.Any(workflowRole.Arn),
Permissions: pulumi.StringArray{
pulumi.String("DATA_LOCATION_ACCESS"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_lakeformation_permissions" "example" {
data_location = {
arn = exampleAwsLakeformationResource.arn
}
principal = workflowRole.arn
permissions = ["DATA_LOCATION_ACCESS"]
}
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.ArrayList;
import java.util.Arrays;
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()
.dataLocation(PermissionsDataLocationArgs.builder()
.arn(exampleAwsLakeformationResource.arn())
.build())
.principal(workflowRole.arn())
.permissions("DATA_LOCATION_ACCESS")
.build());
}
}
resources:
example:
type: aws:lakeformation:Permissions
properties:
dataLocation:
arn: ${exampleAwsLakeformationResource.arn}
principal: ${workflowRole.arn}
permissions:
- DATA_LOCATION_ACCESS
Grant Permissions For A Glue Catalog Database
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.lakeformation.Permissions("example", {
database: {
name: exampleAwsGlueCatalogDatabase.name,
catalogId: "110376042874",
},
principal: workflowRole.arn,
permissions: [
"CREATE_TABLE",
"ALTER",
"DROP",
],
});
import pulumi
import pulumi_aws as aws
example = aws.lakeformation.Permissions("example",
database={
"name": example_aws_glue_catalog_database["name"],
"catalog_id": "110376042874",
},
principal=workflow_role["arn"],
permissions=[
"CREATE_TABLE",
"ALTER",
"DROP",
])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.LakeFormation.Permissions("example", new()
{
Database = new Aws.LakeFormation.Inputs.PermissionsDatabaseArgs
{
Name = exampleAwsGlueCatalogDatabase.Name,
CatalogId = "110376042874",
},
Principal = workflowRole.Arn,
PermissionDetails = new[]
{
"CREATE_TABLE",
"ALTER",
"DROP",
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/lakeformation"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := lakeformation.NewPermissions(ctx, "example", &lakeformation.PermissionsArgs{
Database: &lakeformation.PermissionsDatabaseArgs{
Name: pulumi.Any(exampleAwsGlueCatalogDatabase.Name),
CatalogId: pulumi.String("110376042874"),
},
Principal: pulumi.Any(workflowRole.Arn),
Permissions: pulumi.StringArray{
pulumi.String("CREATE_TABLE"),
pulumi.String("ALTER"),
pulumi.String("DROP"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_lakeformation_permissions" "example" {
database = {
name = exampleAwsGlueCatalogDatabase.name
catalog_id = "110376042874"
}
principal = workflowRole.arn
permissions = ["CREATE_TABLE", "ALTER", "DROP"]
}
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.ArrayList;
import java.util.Arrays;
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()
.database(PermissionsDatabaseArgs.builder()
.name(exampleAwsGlueCatalogDatabase.name())
.catalogId("110376042874")
.build())
.principal(workflowRole.arn())
.permissions(
"CREATE_TABLE",
"ALTER",
"DROP")
.build());
}
}
resources:
example:
type: aws:lakeformation:Permissions
properties:
database:
name: ${exampleAwsGlueCatalogDatabase.name}
catalogId: '110376042874'
principal: ${workflowRole.arn}
permissions:
- CREATE_TABLE
- ALTER
- DROP
Grant Permissions Using Tag-Based Access Control
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.lakeformation.Permissions("test", {
lfTagPolicy: {
expressions: [
{
key: "Team",
values: ["Sales"],
},
{
key: "Environment",
values: [
"Dev",
"Production",
],
},
],
resourceType: "DATABASE",
},
principal: salesRole.arn,
permissions: [
"CREATE_TABLE",
"ALTER",
"DROP",
],
});
import pulumi
import pulumi_aws as aws
test = aws.lakeformation.Permissions("test",
lf_tag_policy={
"expressions": [
{
"key": "Team",
"values": ["Sales"],
},
{
"key": "Environment",
"values": [
"Dev",
"Production",
],
},
],
"resource_type": "DATABASE",
},
principal=sales_role["arn"],
permissions=[
"CREATE_TABLE",
"ALTER",
"DROP",
])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.LakeFormation.Permissions("test", new()
{
LfTagPolicy = new Aws.LakeFormation.Inputs.PermissionsLfTagPolicyArgs
{
Expressions = new[]
{
new Aws.LakeFormation.Inputs.PermissionsLfTagPolicyExpressionArgs
{
Key = "Team",
Values = new[]
{
"Sales",
},
},
new Aws.LakeFormation.Inputs.PermissionsLfTagPolicyExpressionArgs
{
Key = "Environment",
Values = new[]
{
"Dev",
"Production",
},
},
},
ResourceType = "DATABASE",
},
Principal = salesRole.Arn,
PermissionDetails = new[]
{
"CREATE_TABLE",
"ALTER",
"DROP",
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/lakeformation"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := lakeformation.NewPermissions(ctx, "test", &lakeformation.PermissionsArgs{
LfTagPolicy: &lakeformation.PermissionsLfTagPolicyArgs{
Expressions: lakeformation.PermissionsLfTagPolicyExpressionArray{
&lakeformation.PermissionsLfTagPolicyExpressionArgs{
Key: pulumi.String("Team"),
Values: pulumi.StringArray{
pulumi.String("Sales"),
},
},
&lakeformation.PermissionsLfTagPolicyExpressionArgs{
Key: pulumi.String("Environment"),
Values: pulumi.StringArray{
pulumi.String("Dev"),
pulumi.String("Production"),
},
},
},
ResourceType: pulumi.String("DATABASE"),
},
Principal: pulumi.Any(salesRole.Arn),
Permissions: pulumi.StringArray{
pulumi.String("CREATE_TABLE"),
pulumi.String("ALTER"),
pulumi.String("DROP"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_lakeformation_permissions" "test" {
lf_tag_policy = {
expressions = [{
"key" = "Team"
"values" = ["Sales"]
}, {
"key" = "Environment"
"values" = ["Dev", "Production"]
}]
resource_type = "DATABASE"
}
principal = salesRole.arn
permissions = ["CREATE_TABLE", "ALTER", "DROP"]
}
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 com.pulumi.aws.lakeformation.inputs.PermissionsLfTagPolicyExpressionArgs;
import java.util.ArrayList;
import java.util.Arrays;
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()
.lfTagPolicy(PermissionsLfTagPolicyArgs.builder()
.expressions(
PermissionsLfTagPolicyExpressionArgs.builder()
.key("Team")
.values("Sales")
.build(),
PermissionsLfTagPolicyExpressionArgs.builder()
.key("Environment")
.values(
"Dev",
"Production")
.build())
.resourceType("DATABASE")
.build())
.principal(salesRole.arn())
.permissions(
"CREATE_TABLE",
"ALTER",
"DROP")
.build());
}
}
resources:
test:
type: aws:lakeformation:Permissions
properties:
lfTagPolicy:
expressions:
- key: Team
values:
- Sales
- key: Environment
values:
- Dev
- Production
resourceType: DATABASE
principal: ${salesRole.arn}
permissions:
- CREATE_TABLE
- ALTER
- DROP
Constructors
- Permissions(String name, {PermissionsArgs? args, CustomResourceOptions? options})
-
Creates a new Permissions.
nameThe Pulumi resource name.argsArguments used to configure this Permissions. The set of arguments for Permissions.optionsResource options controlling this resource's behavior. - Permissions.reference(String urn)
- Creates a typed reference to an existing Permissions resource.
Properties
-
catalogId
↔ Output<
String?> -
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.
latefinal
-
catalogResource
↔ Output<
bool?> -
Whether the permissions are to be granted for the Data Catalog. Defaults to
false.latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
database
↔ Output<
PermissionsDatabase> -
Configuration block for a database resource. Detailed below.
latefinal
-
dataCellsFilter
↔ Output<
PermissionsDataCellsFilter?> -
Configuration block for a data cells filter resource. Detailed below.
latefinal
-
dataLocation
↔ Output<
PermissionsDataLocation> -
Configuration block for a data location resource. Detailed below.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
lfTag
↔ Output<
PermissionsLfTag> -
Configuration block for an LF-tag resource. Detailed below.
latefinal
-
lfTagPolicy
↔ Output<
PermissionsLfTagPolicy> -
Configuration block for an LF-tag policy resource. Detailed below.
latefinal
-
permissions
↔ Output<
List< String> > -
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, andSELECT. For details on each permission, see Lake Formation Permissions Reference.latefinal -
permissionsWithGrantOptions
↔ Output<
List< String> > -
Subset of
permissionswhich the principal can pass.latefinal -
principal
↔ Output<
String> -
Principal to be granted the permissions on the resource. Supported principals include
IAM_ALLOWED_PRINCIPALS(see Default Behavior andIAMAllowedPrincipalsabove), IAM roles, users, groups, Federated Users, 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.latefinal -
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
table
↔ Output<
PermissionsTable> -
Configuration block for a table resource. Detailed below.
latefinal
-
tableWithColumns
↔ Output<
PermissionsTableWithColumns> -
Configuration block for a table with columns resource. Detailed below.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {PermissionsState? state, CustomResourceOptions? options}) → Permissions -
Gets an existing Permissions resource's state with the given
nameandid.