data_protection_policies

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

Overview

Name	data_protection_policies
Type	Resource
Id	aws.logs.data_protection_policies

Fields

The following fields are returned by SELECT queries:

get_data_protection_policy

Name	Datatype	Description
last_updated_time	integer (int64)	The date and time that this policy was most recently updated.
log_group_identifier	string	The log group name or ARN that you specified in your request. (pattern: <code>[\w#+=/:,.@-]*</code>)
policy_document	string	The data protection policy document for this log group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_protection_policy	select	region		Returns information about a log group data protection policy.
put_data_protection_policy	replace	region, logGroupIdentifier, policyDocument		Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked. By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command. For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking. The PutDataProtectionPolicy operation applies to only the specified log group. You can also use PutAccountPolicy to create an account-level data protection policy that applies to all log groups in the account, including both existing log groups and log groups that are created level. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.
delete_data_protection_policy	delete	region		Deletes the data protection policy from the specified log group. For more information about data protection policies, see PutDataProtectionPolicy.

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_protection_policy

Returns information about a log group data protection policy.

SELECT
last_updated_time,
log_group_identifier,
policy_document
FROM aws.logs.data_protection_policies
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_data_protection_policy

Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked. By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command. For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking. The PutDataProtectionPolicy operation applies to only the specified log group. You can also use PutAccountPolicy to create an account-level data protection policy that applies to all log groups in the account, including both existing log groups and log groups that are created level. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.

REPLACE aws.logs.data_protection_policies
SET 
logGroupIdentifier = '{{ logGroupIdentifier }}',
policyDocument = '{{ policyDocument }}'
WHERE 
region = '{{ region }}' --required
AND logGroupIdentifier = '{{ logGroupIdentifier }}' --required
AND policyDocument = '{{ policyDocument }}' --required
RETURNING
last_updated_time,
log_group_identifier,
policy_document;

DELETE examples

delete_data_protection_policy

Deletes the data protection policy from the specified log group. For more information about data protection policies, see PutDataProtectionPolicy.

DELETE FROM aws.logs.data_protection_policies
WHERE region = '{{ region }}' --required
;