java.lang.Object
- com.pulumi.resources.Resource
- - com.pulumi.resources.CustomResource
  - - com.pulumi.aws.lakeformation.Permissions

public class Permissions
extends com.pulumi.resources.CustomResource

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](https://docs.aws.amazon.com/lake-formation/latest/dg/security-data-access.html). > **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: 1. Use this resource (`aws.lakeformation.Permissions`), change the default security settings using `aws.lakeformation.DataLakeSettings`, and remove existing `IAMAllowedPrincipals` permissions 2. Use `IAMAllowedPrincipals` without `aws.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.

 
 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());
 
     }
 }

To remove existing `IAMAllowedPrincipals` permissions, use the [AWS Lake Formation Console](https://console.aws.amazon.com/lakeformation/) or [AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/batch-revoke-permissions.html). `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 `Super` permission to `IAMAllowedPrincipals` on 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](https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html). ### 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.

 
 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());
 
     }
 }

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.

 
 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());
 
     }
 }

### 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](https://docs.aws.amazon.com/lake-formation/latest/dg/implicit-permissions.html). 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

 
 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());
 
     }
 }

### 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.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());
 
     }
 }

### 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 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());
 
     }
 }

Nested Class Summary
- Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource
  com.pulumi.resources.CustomResource.CustomResourceInternal
- Nested classes/interfaces inherited from class com.pulumi.resources.Resource
  com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

Field Summary
- Fields inherited from class com.pulumi.resources.Resource
  childResources, remote

Constructor Summary

Constructors
Constructor	Description
`Permissions(java.lang.String name)`
`Permissions(java.lang.String name, PermissionsArgs args)`
`Permissions(java.lang.String name, PermissionsArgs args, com.pulumi.resources.CustomResourceOptions options)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`com.pulumi.core.Output<java.util.Optional<java.lang.String>>`	`catalogId()`
`com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>>`	`catalogResource()`
`com.pulumi.core.Output<PermissionsDatabase>`	`database()`
`com.pulumi.core.Output<java.util.Optional<PermissionsDataCellsFilter>>`	`dataCellsFilter()`
`com.pulumi.core.Output<PermissionsDataLocation>`	`dataLocation()`
`static Permissions`	`get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, PermissionsState state, com.pulumi.resources.CustomResourceOptions options)`	Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
`com.pulumi.core.Output<PermissionsLfTag>`	`lfTag()`
`com.pulumi.core.Output<PermissionsLfTagPolicy>`	`lfTagPolicy()`
`com.pulumi.core.Output<java.util.List<java.lang.String>>`	`permissions()`
`com.pulumi.core.Output<java.util.List<java.lang.String>>`	`permissionsWithGrantOptions()`
`com.pulumi.core.Output<java.lang.String>`	`principal()`
`com.pulumi.core.Output<java.lang.String>`	`region()`
`com.pulumi.core.Output<PermissionsTable>`	`table()`
`com.pulumi.core.Output<PermissionsTableWithColumns>`	`tableWithColumns()`

Methods inherited from class com.pulumi.resources.CustomResource
getId, id, idFuture

Methods inherited from class com.pulumi.resources.Resource
getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Permissions
```
public Permissions(java.lang.String name)
```
    Parameters:
    
    name - The _unique_ name of the resulting resource.
  - Permissions
```
public Permissions(java.lang.String name,
                   PermissionsArgs args)
```
    Parameters:
    
    name - The _unique_ name of the resulting resource.
    
    args - The arguments to use to populate this resource's properties.
  - Permissions
```
public Permissions(java.lang.String name,
                   PermissionsArgs args,
                   @Nullable
                   com.pulumi.resources.CustomResourceOptions options)
```
    Parameters:
    
    name - The _unique_ name of the resulting resource.
    
    args - The arguments to use to populate this resource's properties.
    
    options - A bag of options that control this resource's behavior.
- Method Detail
  - catalogId
```
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> catalogId()
```
    Returns:
    
    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.
  - catalogResource
```
public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> catalogResource()
```
    Returns:
    
    Whether the permissions are to be granted for the Data Catalog. Defaults to `false`.
  - dataCellsFilter
```
public com.pulumi.core.Output<java.util.Optional<PermissionsDataCellsFilter>> dataCellsFilter()
```
    Returns:
    
    Configuration block for a data cells filter resource. Detailed below.
  - dataLocation
```
public com.pulumi.core.Output<PermissionsDataLocation> dataLocation()
```
    Returns:
    
    Configuration block for a data location resource. Detailed below.
  - database
```
public com.pulumi.core.Output<PermissionsDatabase> database()
```
    Returns:
    
    Configuration block for a database resource. Detailed below.
  - lfTag
```
public com.pulumi.core.Output<PermissionsLfTag> lfTag()
```
    Returns:
    
    Configuration block for an LF-tag resource. Detailed below.
  - lfTagPolicy
```
public com.pulumi.core.Output<PermissionsLfTagPolicy> lfTagPolicy()
```
    Returns:
    
    Configuration block for an LF-tag policy resource. Detailed below.
  - permissions
```
public com.pulumi.core.Output<java.util.List<java.lang.String>> permissions()
```
    Returns:
    
    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](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html).
  - permissionsWithGrantOptions
```
public com.pulumi.core.Output<java.util.List<java.lang.String>> permissionsWithGrantOptions()
```
    Returns:
    
    Subset of `permissions` which the principal can pass.
  - principal
```
public com.pulumi.core.Output<java.lang.String> principal()
```
    Returns:
    
    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, 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](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html). > **NOTE:** We highly recommend that the `principal` _NOT_ be a Lake Formation administrator (granted using `aws.lakeformation.DataLakeSettings`). The entity (e.g., IAM role) running the deployment will most likely need to be a Lake Formation administrator. As such, the entity will have implicit permissions and does not need permissions granted through this resource. One of the following is required:
  - region
```
public com.pulumi.core.Output<java.lang.String> region()
```
    Returns:
    
    Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
  - table
```
public com.pulumi.core.Output<PermissionsTable> table()
```
    Returns:
    
    Configuration block for a table resource. Detailed below.
  - tableWithColumns
```
public com.pulumi.core.Output<PermissionsTableWithColumns> tableWithColumns()
```
    Returns:
    
    Configuration block for a table with columns resource. Detailed below. The following arguments are optional:
  - get
```
public static Permissions get(java.lang.String name,
                              com.pulumi.core.Output<java.lang.String> id,
                              @Nullable
                              PermissionsState state,
                              @Nullable
                              com.pulumi.resources.CustomResourceOptions options)
```
    Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
    
    Parameters:
    
    name - The _unique_ name of the resulting resource.
    
    id - The _unique_ provider ID of the resource to lookup.
    
    state -
    
    options - Optional settings to control the behavior of the CustomResource.

Class Permissions

Nested Class Summary

Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

Nested classes/interfaces inherited from class com.pulumi.resources.Resource

Field Summary

Fields inherited from class com.pulumi.resources.Resource

Constructor Summary

Method Summary

Methods inherited from class com.pulumi.resources.CustomResource

Methods inherited from class com.pulumi.resources.Resource

Methods inherited from class java.lang.Object

Constructor Detail

Permissions

Permissions

Permissions

Method Detail

catalogId

catalogResource

dataCellsFilter

dataLocation

database

lfTag

lfTagPolicy

permissions

permissionsWithGrantOptions

principal

region

table

tableWithColumns

get