lake_formation_identity_center_configurations

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

Overview

Name	lake_formation_identity_center_configurations
Type	Resource
Id	aws.lakeformation.lake_formation_identity_center_configurations

Fields

The following fields are returned by SELECT queries:

describe_lake_formation_identity_center_configuration

Name	Datatype	Description
application_arn	string	The Amazon Resource Name (ARN) of the Lake Formation application integrated with IAM Identity Center.
catalog_id	string	The 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. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
external_filtering	object	Configuration for enabling external data filtering for third-party applications to access data managed by Lake Formation .
instance_arn	string	The Amazon Resource Name (ARN) of the connection.
resource_share	string	The Amazon Resource Name (ARN) of the RAM share.
service_integrations	array	A list of service integrations for trusted identity propagation.
share_recipients	array	A list of Amazon Web Services account IDs or Amazon Web Services organization/organizational unit ARNs that are allowed to access data managed by Lake Formation. If the ShareRecipients list includes valid values, a resource share is created with the principals you want to have access to the resources as the ShareRecipients. If the ShareRecipients value is null or the list is empty, no resource share is created.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_lake_formation_identity_center_configuration	select	region		Retrieves the instance ARN and application ARN for the connection.
create_lake_formation_identity_center_configuration	insert	region		Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources.
update_lake_formation_identity_center_configuration	update	region		Updates the IAM Identity Center connection parameters.
delete_lake_formation_identity_center_configuration	delete	region		Deletes an IAM Identity Center connection with Lake Formation.

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

describe_lake_formation_identity_center_configuration

Retrieves the instance ARN and application ARN for the connection.

SELECT
application_arn,
catalog_id,
external_filtering,
instance_arn,
resource_share,
service_integrations,
share_recipients
FROM aws.lakeformation.lake_formation_identity_center_configurations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_lake_formation_identity_center_configuration

Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources.

INSERT INTO aws.lakeformation.lake_formation_identity_center_configurations (
CatalogId,
InstanceArn,
ExternalFiltering,
ShareRecipients,
ServiceIntegrations,
region
)
SELECT 
'{{ CatalogId }}',
'{{ InstanceArn }}',
'{{ ExternalFiltering }}',
'{{ ShareRecipients }}',
'{{ ServiceIntegrations }}',
'{{ region }}'
RETURNING
application_arn
;

Manifest

# Description fields are for documentation purposes
- name: lake_formation_identity_center_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the lake_formation_identity_center_configurations resource.
  - name: CatalogId
    value: "{{ CatalogId }}"
  - name: InstanceArn
    value: "{{ InstanceArn }}"
  - name: ExternalFiltering
    description: |
      Configuration for enabling external data filtering for third-party applications to access data managed by Lake Formation .
    value:
      Status: "{{ Status }}"
      AuthorizedTargets:
        - "{{ AuthorizedTargets }}"
  - name: ShareRecipients
    value:
      - DataLakePrincipalIdentifier: "{{ DataLakePrincipalIdentifier }}"
  - name: ServiceIntegrations
    description: |
      A list of service integrations for trusted identity propagation.
    value:
      - Redshift: "{{ Redshift }}"

UPDATE examples

update_lake_formation_identity_center_configuration

Updates the IAM Identity Center connection parameters.

UPDATE aws.lakeformation.lake_formation_identity_center_configurations
SET 
CatalogId = '{{ CatalogId }}',
ShareRecipients = '{{ ShareRecipients }}',
ServiceIntegrations = '{{ ServiceIntegrations }}',
ApplicationStatus = '{{ ApplicationStatus }}',
ExternalFiltering = '{{ ExternalFiltering }}'
WHERE 
region = '{{ region }}' --required;

DELETE examples

delete_lake_formation_identity_center_configuration

Deletes an IAM Identity Center connection with Lake Formation.

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