account_configurations

Creates, updates, deletes, gets or lists an account_configurations resource.

Overview

Name	account_configurations
Type	Resource
Id	aws.codeguru_security.account_configurations

Fields

The following fields are returned by SELECT queries:

get_account_configuration

Name	Datatype	Description
kms_key_arn	string	The KMS key ARN that is used for encryption. If an AWS-managed key is used for encryption, returns empty. (pattern: <code>arn:aws:kms:[\S]+:[\d]{12}:key/(([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|(mrk-[0-9a-zA-Z]{32}))</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_account_configuration	select	region		Use to get the encryption configuration for an account.
update_account_configuration	update	region, encryptionConfig		Use to update the encryption configuration for an account.

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_account_configuration

Use to get the encryption configuration for an account.

SELECT
kms_key_arn
FROM aws.codeguru_security.account_configurations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_account_configuration

Use to update the encryption configuration for an account.

UPDATE aws.codeguru_security.account_configurations
SET 
encryptionConfig = '{{ encryptionConfig }}'
WHERE 
region = '{{ region }}' --required
AND encryptionConfig = '{{ encryptionConfig }}' --required
RETURNING
encryption_config;