data_lake_exception_subscriptions

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

Overview

Name	data_lake_exception_subscriptions
Type	Resource
Id	aws.securitylake.data_lake_exception_subscriptions

Fields

The following fields are returned by SELECT queries:

get_data_lake_exception_subscription

Name	Datatype	Description
exception_time_to_live	integer (int64)	The expiration period and time-to-live (TTL). It is the duration of time until which the exception message remains.
notification_endpoint	string	The Amazon Web Services account where you receive exception notifications. (pattern: <code>^[\\w-_:/.@=+]*$</code>)
subscription_protocol	string	The subscription protocol to which exception notifications are posted. (pattern: <code>^[a-z-]*$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_lake_exception_subscription	select	region		Retrieves the protocol and endpoint that were provided when subscribing to Amazon SNS topics for exception notifications.
create_data_lake_exception_subscription	insert	region, notificationEndpoint, subscriptionProtocol		Creates the specified notification subscription in Amazon Security Lake for the organization you specify. The notification subscription is created for exceptions that cannot be resolved by Security Lake automatically.
update_data_lake_exception_subscription	update	region, notificationEndpoint, subscriptionProtocol		Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
delete_data_lake_exception_subscription	delete	region		Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.

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_exception_subscription

Retrieves the protocol and endpoint that were provided when subscribing to Amazon SNS topics for exception notifications.

SELECT
exception_time_to_live,
notification_endpoint,
subscription_protocol
FROM aws.securitylake.data_lake_exception_subscriptions
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_data_lake_exception_subscription

Creates the specified notification subscription in Amazon Security Lake for the organization you specify. The notification subscription is created for exceptions that cannot be resolved by Security Lake automatically.

INSERT INTO aws.securitylake.data_lake_exception_subscriptions (
exceptionTimeToLive,
notificationEndpoint,
subscriptionProtocol,
region
)
SELECT 
{{ exceptionTimeToLive }},
'{{ notificationEndpoint }}' /* required */,
'{{ subscriptionProtocol }}' /* required */,
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: data_lake_exception_subscriptions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_lake_exception_subscriptions resource.
  - name: exceptionTimeToLive
    value: {{ exceptionTimeToLive }}
  - name: notificationEndpoint
    value: "{{ notificationEndpoint }}"
  - name: subscriptionProtocol
    value: "{{ subscriptionProtocol }}"

UPDATE examples

update_data_lake_exception_subscription

Updates the specified notification subscription in Amazon Security Lake for the organization you specify.

UPDATE aws.securitylake.data_lake_exception_subscriptions
SET 
exceptionTimeToLive = {{ exceptionTimeToLive }},
notificationEndpoint = '{{ notificationEndpoint }}',
subscriptionProtocol = '{{ subscriptionProtocol }}'
WHERE 
region = '{{ region }}' --required
AND notificationEndpoint = '{{ notificationEndpoint }}' --required
AND subscriptionProtocol = '{{ subscriptionProtocol }}' --required;

DELETE examples

delete_data_lake_exception_subscription

Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.

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