subscribers

Creates, updates, deletes or gets a subscriber resource or lists subscribers in a region

Overview

Name	subscribers
Type	Resource
Description	Resource Type definition for AWS::SecurityLake::Subscriber
Id	awscc.securitylake.subscribers

Fields

get (all properties)

Name	Datatype	Description
access_types	array	The Amazon S3 or AWS Lake Formation access type.
data_lake_arn	string	The ARN for the data lake.
▶subscriber_identity	object	The AWS identity used to access your data.
subscriber_name	string	The name of your Security Lake subscriber account.
subscriber_description	string	The description for your subscriber account in Security Lake.
▶tags	array	An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
▶sources	array	The supported AWS services from which logs and events are collected.
resource_share_arn	string
resource_share_name	string
subscriber_role_arn	string
s3_bucket_arn	string
subscriber_arn	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
subscriber_arn	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	subscribers	INSERT	AccessTypes, DataLakeArn, Sources, SubscriberIdentity, SubscriberName, region
delete_resource	subscribers	DELETE	Identifier, region
update_resource	subscribers	UPDATE	Identifier, PatchDocument, region
list_resources	subscribers_list_only	SELECT	region
get_resource	subscribers	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual subscriber.

SELECT
  region,
  access_types,
  data_lake_arn,
  subscriber_identity,
  subscriber_name,
  subscriber_description,
  tags,
  sources,
  resource_share_arn,
  resource_share_name,
  subscriber_role_arn,
  s3_bucket_arn,
  subscriber_arn
FROM awscc.securitylake.subscribers
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ subscriber_arn }}';

list (identifiers only)

Lists all subscribers in a region.

SELECT
  region,
  subscriber_arn
FROM awscc.securitylake.subscribers_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.securitylake.subscribers (
  AccessTypes,
  DataLakeArn,
  SubscriberIdentity,
  SubscriberName,
  Sources,
  region
)
SELECT
  '{{ access_types }}',
  '{{ data_lake_arn }}',
  '{{ subscriber_identity }}',
  '{{ subscriber_name }}',
  '{{ sources }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.securitylake.subscribers (
  AccessTypes,
  DataLakeArn,
  SubscriberIdentity,
  SubscriberName,
  SubscriberDescription,
  Tags,
  Sources,
  region
)
SELECT
  '{{ access_types }}',
  '{{ data_lake_arn }}',
  '{{ subscriber_identity }}',
  '{{ subscriber_name }}',
  '{{ subscriber_description }}',
  '{{ tags }}',
  '{{ sources }}',
  '{{ 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: subscriber
  props:
    - name: access_types
      value:
        - '{{ access_types[0] }}'
    - name: data_lake_arn
      value: '{{ data_lake_arn }}'
    - name: subscriber_identity
      value:
        external_id: '{{ external_id }}'
        principal: '{{ principal }}'
    - name: subscriber_name
      value: '{{ subscriber_name }}'
    - name: subscriber_description
      value: '{{ subscriber_description }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: sources
      value:
        - null

UPDATE example

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

/*+ update */
UPDATE awscc.securitylake.subscribers
SET PatchDocument = string('{{ {
    "AccessTypes": access_types,
    "SubscriberIdentity": subscriber_identity,
    "SubscriberName": subscriber_name,
    "SubscriberDescription": subscriber_description,
    "Tags": tags,
    "Sources": sources
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ subscriber_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Create

securitylake:CreateSubscriber,
securitylake:CreateCustomLogSource,
securitylake:CreateDataLake,
securitylake:TagResource,
securitylake:GetSubscriber,
securitylake:ListSubscribers,
securitylake:ListTagsForResource,
iam:GetRole,
iam:GetRolePolicy,
iam:PutRolePolicy,
iam:CreateRole,
iam:CreateServiceLinkedRole,
glue:GetDatabase,
glue:GetTable,
lakeformation:RegisterResource,
lakeformation:GrantPermissions,
lakeformation:RevokePermissions,
lakeformation:ListPermissions,
ram:GetResourceShareAssociations,
ram:CreateResourceShare,
ram:UpdateResourceShare,
ram:GetResourceShares

Read

securitylake:GetSubscriber,
securitylake:ListTagsForResource

Update

securitylake:UpdateSubscriber,
securitylake:GetSubscriber,
securitylake:TagResource,
securitylake:UntagResource,
securitylake:ListTagsForResource,
glue:GetDatabase,
glue:GetTable,
lakeformation:ListPermissions,
lakeformation:GrantPermissions,
lakeformation:RevokePermissions,
ram:CreateResourceShare,
ram:GetResourceShares,
ram:GetResourceShareAssociations,
ram:UpdateResourceShare,
ram:DeleteResourceShare,
iam:CreateRole,
iam:GetRole,
iam:DeleteRole,
iam:PutRolePolicy,
iam:DeleteRolePolicy,
iam:ListRolePolicies,
events:CreateApiDestination,
events:CreateConnection,
events:ListApiDestinations,
events:ListConnections,
events:PutRule,
events:UpdateApiDestination,
events:UpdateConnection,
events:DeleteApiDestination,
events:DeleteConnection,
events:DeleteRule,
events:RemoveTargets,
events:ListTargetsByRule,
events:DescribeRule,
events:PutTargets

Delete

securitylake:DeleteSubscriber,
iam:GetRole,
iam:ListRolePolicies,
iam:DeleteRole,
iam:DeleteRolePolicy,
glue:GetTable,
lakeformation:RevokePermissions,
lakeformation:ListPermissions,
ram:GetResourceShares,
ram:DeleteResourceShare,
events:DeleteApiDestination,
events:DeleteConnection,
events:DeleteRule,
events:ListApiDestinations,
events:ListTargetsByRule,
events:DescribeRule,
events:RemoveTargets,
sqs:DeleteQueue,
sqs:GetQueueUrl

List

securitylake:ListSubscribers