data_lake_organization_configurations

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

Overview

Name	data_lake_organization_configurations
Type	Resource
Id	aws.securitylake.data_lake_organization_configurations

Fields

The following fields are returned by SELECT queries:

get_data_lake_organization_configuration

Name	Datatype	Description
auto_enable_new_account	array	The configuration used for new accounts in Security Lake.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_lake_organization_configuration	select	region		Retrieves the configuration that will be automatically set up for accounts added to the organization after the organization has onboarded to Amazon Security Lake. This API does not take input parameters.
create_data_lake_organization_configuration	insert	region		Automatically enables Amazon Security Lake for new member accounts in your organization. Security Lake is not automatically enabled for any existing member accounts in your organization. This operation merges the new data lake organization configuration with the existing configuration for Security Lake in your organization. If you want to create a new data lake organization configuration, you must delete the existing one using DeleteDataLakeOrganizationConfiguration.
delete_data_lake_organization_configuration	delete	region		Turns off automatic enablement of Amazon Security Lake for member accounts that are added to an organization in Organizations. Only the delegated Security Lake administrator for an organization can perform this operation. If the delegated Security Lake administrator performs this operation, new member accounts won't automatically contribute data to the data lake.

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

get_data_lake_organization_configuration

Retrieves the configuration that will be automatically set up for accounts added to the organization after the organization has onboarded to Amazon Security Lake. This API does not take input parameters.

SELECT
auto_enable_new_account
FROM aws.securitylake.data_lake_organization_configurations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_data_lake_organization_configuration

Automatically enables Amazon Security Lake for new member accounts in your organization. Security Lake is not automatically enabled for any existing member accounts in your organization. This operation merges the new data lake organization configuration with the existing configuration for Security Lake in your organization. If you want to create a new data lake organization configuration, you must delete the existing one using DeleteDataLakeOrganizationConfiguration.

INSERT INTO aws.securitylake.data_lake_organization_configurations (
autoEnableNewAccount,
region
)
SELECT 
'{{ autoEnableNewAccount }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: data_lake_organization_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_lake_organization_configurations resource.
  - name: autoEnableNewAccount
    value:
      - region: "{{ region }}"
        sources: "{{ sources }}"

DELETE examples

delete_data_lake_organization_configuration

Turns off automatic enablement of Amazon Security Lake for member accounts that are added to an organization in Organizations. Only the delegated Security Lake administrator for an organization can perform this operation. If the delegated Security Lake administrator performs this operation, new member accounts won't automatically contribute data to the data lake.

DELETE FROM aws.securitylake.data_lake_organization_configurations
WHERE region = '{{ region }}' --required
;