lake_formation_opt_ins

Creates, updates, deletes, gets or lists a lake_formation_opt_ins resource.

Overview

Name	lake_formation_opt_ins
Type	Resource
Id	aws.lakeformation.lake_formation_opt_ins

Fields

The following fields are returned by SELECT queries:

list_lake_formation_opt_ins

Name	Datatype	Description
lake_formation_opt_ins_info_list	array	A list of principal-resource pairs that have Lake Formation permissins enforced.
next_token	string	A continuation token, if this is not the first call to retrieve this list.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_lake_formation_opt_ins	select	region		Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.
create_lake_formation_opt_in	insert	region, Principal, Resource		Enforce Lake Formation permissions for the given databases, tables, and principals.
delete_lake_formation_opt_in	delete	region		Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_lake_formation_opt_ins

Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.

SELECT
lake_formation_opt_ins_info_list,
next_token
FROM aws.lakeformation.lake_formation_opt_ins
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_lake_formation_opt_in

Enforce Lake Formation permissions for the given databases, tables, and principals.

INSERT INTO aws.lakeformation.lake_formation_opt_ins (
Principal,
Resource,
Condition,
region
)
SELECT 
'{{ Principal }}' /* required */,
'{{ Resource }}' /* required */,
'{{ Condition }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: lake_formation_opt_ins
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the lake_formation_opt_ins resource.
  - name: Principal
    description: |
      The Lake Formation principal. Supported principals are IAM users or IAM roles.
    value:
      DataLakePrincipalIdentifier: "{{ DataLakePrincipalIdentifier }}"
  - name: Resource
    description: |
      A structure for the resource.
    value:
      Catalog:
        Id: "{{ Id }}"
      Database:
        CatalogId: "{{ CatalogId }}"
        Name: "{{ Name }}"
      Table:
        CatalogId: "{{ CatalogId }}"
        DatabaseName: "{{ DatabaseName }}"
        Name: "{{ Name }}"
        TableWildcard: "{{ TableWildcard }}"
      TableWithColumns:
        CatalogId: "{{ CatalogId }}"
        DatabaseName: "{{ DatabaseName }}"
        Name: "{{ Name }}"
        ColumnNames:
          - "{{ ColumnNames }}"
        ColumnWildcard:
          ExcludedColumnNames:
            - "{{ ExcludedColumnNames }}"
      DataLocation:
        CatalogId: "{{ CatalogId }}"
        ResourceArn: "{{ ResourceArn }}"
      DataCellsFilter:
        TableCatalogId: "{{ TableCatalogId }}"
        DatabaseName: "{{ DatabaseName }}"
        TableName: "{{ TableName }}"
        Name: "{{ Name }}"
      LFTag:
        CatalogId: "{{ CatalogId }}"
        TagKey: "{{ TagKey }}"
        TagValues:
          - "{{ TagValues }}"
      LFTagPolicy:
        CatalogId: "{{ CatalogId }}"
        ResourceType: "{{ ResourceType }}"
        Expression:
          - TagKey: "{{ TagKey }}"
            TagValues: "{{ TagValues }}"
        ExpressionName: "{{ ExpressionName }}"
      LFTagExpression:
        CatalogId: "{{ CatalogId }}"
        Name: "{{ Name }}"
  - name: Condition
    description: |
      A Lake Formation condition, which applies to permissions and opt-ins that contain an expression.
    value:
      Expression: "{{ Expression }}"

DELETE examples

delete_lake_formation_opt_in

Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.

DELETE FROM aws.lakeformation.lake_formation_opt_ins
WHERE region = '{{ region }}' --required
;