settings
Creates, updates, deletes, gets or lists a settings resource.
Overview
| Name | settings |
| Type | Resource |
| Id | aws.auditmanager.settings |
Fields
The following fields are returned by SELECT queries:
- get_settings
| Name | Datatype | Description |
|---|---|---|
default_assessment_reports_destination | object | The location where Audit Manager saves assessment reports for the given assessment. |
default_export_destination | object | The default S3 destination bucket for storing evidence finder exports. |
default_process_owners | array | The designated default audit owners. |
deregistration_policy | object | The deregistration policy for your Audit Manager data. You can use this attribute to determine how your data is handled when you deregister Audit Manager. |
evidence_finder_enablement | object | The current evidence finder status and event data store details. |
is_aws_org_enabled | boolean | Specifies whether Organizations is enabled. |
kms_key | string | The KMS key details. (pattern: <code>^arn:.:kms:.|DEFAULT</code>) |
sns_topic | string | The designated Amazon Simple Notification Service (Amazon SNS) topic. (pattern: <code>^[a-zA-Z0-9-_()[]]+$</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_settings | select | attribute, region | Gets the settings for a specified Amazon Web Services account. | |
update_settings | update | region | Updates Audit Manager settings for the current 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 |
|---|---|---|
attribute | string | The list of setting attribute enum values. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_settings
Gets the settings for a specified Amazon Web Services account.
SELECT
default_assessment_reports_destination,
default_export_destination,
default_process_owners,
deregistration_policy,
evidence_finder_enablement,
is_aws_org_enabled,
kms_key,
sns_topic
FROM aws.auditmanager.settings
WHERE attribute = '{{ attribute }}' -- required
AND region = '{{ region }}' -- required
;
UPDATE examples
- update_settings
Updates Audit Manager settings for the current account.
UPDATE aws.auditmanager.settings
SET
snsTopic = '{{ snsTopic }}',
defaultAssessmentReportsDestination = '{{ defaultAssessmentReportsDestination }}',
defaultProcessOwners = '{{ defaultProcessOwners }}',
kmsKey = '{{ kmsKey }}',
evidenceFinderEnabled = {{ evidenceFinderEnabled }},
deregistrationPolicy = '{{ deregistrationPolicy }}',
defaultExportDestination = '{{ defaultExportDestination }}'
WHERE
region = '{{ region }}' --required
RETURNING
settings;