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	awscc.securitylake.data_lakes

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) created by you to provide to the subscriber.
region	string	AWS region.

For more information, see AWS::SecurityLake::DataLake.

Methods

Name	Resource	Accessible by	Required Params
create_resource	data_lakes	INSERT	region
delete_resource	data_lakes	DELETE	Identifier, region
update_resource	data_lakes	UPDATE	Identifier, PatchDocument, region
list_resources	data_lakes_list_only	SELECT	region
get_resource	data_lakes	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.securitylake.data_lakes
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all data_lakes in a region.

SELECT
  region,
  arn
FROM awscc.securitylake.data_lakes_list_only
WHERE
  region = '{{ region }}';

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 awscc.securitylake.data_lakes (
  EncryptionConfiguration,
  LifecycleConfiguration,
  ReplicationConfiguration,
  MetaStoreManagerRoleArn,
  Tags,
  region
)
SELECT
  '{{ encryption_configuration }}',
  '{{ lifecycle_configuration }}',
  '{{ replication_configuration }}',
  '{{ meta_store_manager_role_arn }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.securitylake.data_lakes (
  EncryptionConfiguration,
  LifecycleConfiguration,
  ReplicationConfiguration,
  MetaStoreManagerRoleArn,
  Tags,
  region
)
SELECT
  '{{ encryption_configuration }}',
  '{{ lifecycle_configuration }}',
  '{{ replication_configuration }}',
  '{{ meta_store_manager_role_arn }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: data_lake
  props:
    - name: encryption_configuration
      value:
        kms_key_id: '{{ kms_key_id }}'
    - name: lifecycle_configuration
      value:
        expiration:
          days: '{{ days }}'
        transitions:
          - days: '{{ days }}'
            storage_class: '{{ storage_class }}'
    - name: replication_configuration
      value:
        regions:
          - '{{ regions[0] }}'
        role_arn: '{{ role_arn }}'
    - name: meta_store_manager_role_arn
      value: '{{ meta_store_manager_role_arn }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.securitylake.data_lakes
SET PatchDocument = string('{{ {
    "EncryptionConfiguration": encryption_configuration,
    "LifecycleConfiguration": lifecycle_configuration,
    "ReplicationConfiguration": replication_configuration,
    "MetaStoreManagerRoleArn": meta_store_manager_role_arn,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.securitylake.data_lakes
WHERE
  Identifier = '{{ arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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*