aws_log_sources

Creates, updates, deletes or gets an aws_log_source resource or lists aws_log_sources in a region

Overview

Name	aws_log_sources
Type	Resource
Description	Resource Type definition for AWS::SecurityLake::AwsLogSource
Id	awscc.securitylake.aws_log_sources

Fields

get (all properties)

Name	Datatype	Description
accounts	array	AWS account where you want to collect logs from.
data_lake_arn	string	The ARN for the data lake.
source_name	string	The name for a AWS source. This must be a Regionally unique value.
source_version	string	The version for a AWS source. This must be a Regionally unique value.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
source_name	string	The name for a AWS source. This must be a Regionally unique value.
source_version	string	The version for a AWS source. This must be a Regionally unique value.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	aws_log_sources	INSERT	DataLakeArn, SourceVersion, SourceName, region
delete_resource	aws_log_sources	DELETE	Identifier, region
update_resource	aws_log_sources	UPDATE	Identifier, PatchDocument, region
list_resources	aws_log_sources_list_only	SELECT	region
get_resource	aws_log_sources	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual aws_log_source.

SELECT
  region,
  accounts,
  data_lake_arn,
  source_name,
  source_version
FROM awscc.securitylake.aws_log_sources
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ source_name }}|{{ source_version }}';

list (identifiers only)

Lists all aws_log_sources in a region.

SELECT
  region,
  source_name,
  source_version
FROM awscc.securitylake.aws_log_sources_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.securitylake.aws_log_sources (
  DataLakeArn,
  SourceName,
  SourceVersion,
  region
)
SELECT
  '{{ data_lake_arn }}',
  '{{ source_name }}',
  '{{ source_version }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.securitylake.aws_log_sources (
  Accounts,
  DataLakeArn,
  SourceName,
  SourceVersion,
  region
)
SELECT
  '{{ accounts }}',
  '{{ data_lake_arn }}',
  '{{ source_name }}',
  '{{ source_version }}',
  '{{ 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: aws_log_source
  props:
    - name: accounts
      value:
        - '{{ accounts[0] }}'
    - name: data_lake_arn
      value: '{{ data_lake_arn }}'
    - name: source_name
      value: '{{ source_name }}'
    - name: source_version
      value: '{{ source_version }}'

UPDATE example

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

/*+ update */
UPDATE awscc.securitylake.aws_log_sources
SET PatchDocument = string('{{ {
    "Accounts": accounts
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ source_name }}|{{ source_version }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.securitylake.aws_log_sources
WHERE
  Identifier = '{{ source_name }}|{{ source_version }}' 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 aws_log_sources resource, the following permissions are required:

Create

glue:CreateDatabase,
glue:CreateTable,
glue:GetDatabase,
glue:GetTable,
iam:CreateServiceLinkedRole,
kms:CreateGrant,
kms:DescribeKey,
securitylake:CreateDataLake,
securitylake:CreateAwsLogSource,
securitylake:ListLogSources

Read

securitylake:ListLogSources

List

securitylake:ListLogSources

Delete

securitylake:DeleteAwsLogSource,
securitylake:ListLogSources

Update

securitylake:CreateAwsLogSource,
securitylake:DeleteAwsLogSource,
glue:CreateDatabase,
glue:CreateTable,
glue:GetDatabase,
glue:GetTable,
iam:CreateServiceLinkedRole,
kms:CreateGrant,
kms:DescribeKey