data_lakes

Creates, updates, deletes or gets a data_lake resource or lists data_lakes in a region

Overview

Name	data_lakes
Type	Resource
Description	Resource Type definition for AWS::SecurityLake::DataLake
Id	aws.securitylake.data_lakes

Fields

Name	Datatype	Description
encryption_configuration	object	Provides encryption details of Amazon Security Lake object.
lifecycle_configuration	object	Provides lifecycle details of Amazon Security Lake object.
replication_configuration	object	Provides replication details of Amazon Security Lake object.
meta_store_manager_role_arn	string	The Amazon Resource Name (ARN) used to index AWS Glue table partitions that are generated by the ingestion and normalization of AWS log sources and custom sources.
tags	array
arn	string	The Amazon Resource Name (ARN) created by you to provide to the subscriber.
s3_bucket_arn	string	The ARN for the Amazon Security Lake Amazon S3 bucket.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all data_lakes in a region.

SELECT
region,
encryption_configuration,
lifecycle_configuration,
replication_configuration,
meta_store_manager_role_arn,
tags,
arn,
s3_bucket_arn
FROM aws.securitylake.data_lakes
WHERE region = 'us-east-1';

Gets all properties from an individual data_lake.

SELECT
region,
encryption_configuration,
lifecycle_configuration,
replication_configuration,
meta_store_manager_role_arn,
tags,
arn,
s3_bucket_arn
FROM aws.securitylake.data_lakes
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

Use the following StackQL query and manifest file to create a new data_lake resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.securitylake.data_lakes (
 EncryptionConfiguration,
 LifecycleConfiguration,
 ReplicationConfiguration,
 MetaStoreManagerRoleArn,
 Tags,
 region
)
SELECT 
'{{ EncryptionConfiguration }}',
 '{{ LifecycleConfiguration }}',
 '{{ ReplicationConfiguration }}',
 '{{ MetaStoreManagerRoleArn }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.securitylake.data_lakes (
 EncryptionConfiguration,
 LifecycleConfiguration,
 ReplicationConfiguration,
 MetaStoreManagerRoleArn,
 Tags,
 region
)
SELECT 
 '{{ EncryptionConfiguration }}',
 '{{ LifecycleConfiguration }}',
 '{{ ReplicationConfiguration }}',
 '{{ MetaStoreManagerRoleArn }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: data_lake
    props:
      - name: EncryptionConfiguration
        value:
          KmsKeyId: '{{ KmsKeyId }}'
      - name: LifecycleConfiguration
        value:
          Expiration:
            Days: '{{ Days }}'
          Transitions:
            - Days: '{{ Days }}'
              StorageClass: '{{ StorageClass }}'
      - name: ReplicationConfiguration
        value:
          Regions:
            - '{{ Regions[0] }}'
          RoleArn: '{{ RoleArn }}'
      - name: MetaStoreManagerRoleArn
        value: '{{ MetaStoreManagerRoleArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.securitylake.data_lakes
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

To operate on the data_lakes resource, the following permissions are required:

Create

events:*,
iam:CreateServiceLinkedRole,
iam:GetRole,
iam:ListAttachedRolePolicies,
iam:PutRolePolicy,
iam:PassRole,
glue:*,
organizations:*,
kms:DescribeKey,
kms:CreateGrant,
lakeformation:*,
lambda:*,
s3:*,
securitylake:CreateDataLake,
securitylake:TagResource,
securitylake:List*,
sqs:*

Update

events:*,
iam:CreateServiceLinkedRole,
iam:DeleteRolePolicy,
iam:GetRole,
iam:PassRole,
iam:PutRolePolicy,
kms:DescribeKey,
kms:CreateGrant,
lakeformation:*,
lambda:*,
organizations:*,
s3:*,
securitylake:List*,
securitylake:TagResource,
securitylake:UntagResource,
securitylake:UpdateDataLake,
sqs:*

Delete

organizations:*,
securitylake:DeleteDataLake,
securitylake:List*

Read

securitylake:List*

List

securitylake:List*