enabled_baselines

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

Overview

Name	enabled_baselines
Type	Resource
Id	aws.controltower.enabled_baselines

Fields

The following fields are returned by SELECT queries:

get_enabled_baseline

Name	Datatype	Description
arn	string	The ARN of the EnabledBaseline resource. (pattern: <code>arn:aws[0-9a-zA-Z_-:/]+</code>)
baseline_identifier	string	The specific Baseline enabled as part of the EnabledBaseline resource.
baseline_version	string	The enabled version of the Baseline.
drift_status_summary	object	The drift status of the enabled baseline.
parameters	array	Shows the parameters that are applied when enabling this Baseline.
parent_identifier	string	An ARN that represents the parent EnabledBaseline at the Organizational Unit (OU) level, from which the child EnabledBaseline inherits its configuration. The value is returned by GetEnabledBaseline. (pattern: <code>arn:aws[0-9a-zA-Z_-:/]+</code>)
status_summary	object	The deployment summary of an EnabledControl or EnabledBaseline resource.
target_identifier	string	The target on which to enable the Baseline.

list_enabled_baselines

Name	Datatype	Description
arn	string	The ARN of the EnabledBaseline resource (pattern: <code>arn:aws[0-9a-zA-Z_-:/]+</code>)
baseline_identifier	string	The specific baseline that is enabled as part of the EnabledBaseline resource.
baseline_version	string	The enabled version of the baseline.
drift_status_summary	object	The drift status of the enabled baseline.
parent_identifier	string	An ARN that represents an object returned by ListEnabledBaseline, to describe an enabled baseline. (pattern: <code>arn:aws[0-9a-zA-Z_-:/]+</code>)
status_summary	object	The deployment summary of an EnabledControl or EnabledBaseline resource.
target_identifier	string	The target upon which the baseline is enabled.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_enabled_baseline	select	region		Retrieve details of an EnabledBaseline resource by specifying its identifier.
list_enabled_baselines	select	region		Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources. For usage examples, see the Amazon Web Services Control Tower User Guide .
update_enabled_baseline	update	region, baselineVersion, enabledBaselineIdentifier		Updates an EnabledBaseline resource's applied parameters or version. For usage examples, see the Amazon Web Services Control Tower User Guide .
reset_enabled_baseline	exec	region, enabledBaselineIdentifier		Re-enables an EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU. For usage examples, see the Amazon Web Services Control Tower User Guide .

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_enabled_baseline

Retrieve details of an EnabledBaseline resource by specifying its identifier.

SELECT
arn,
baseline_identifier,
baseline_version,
drift_status_summary,
parameters,
parent_identifier,
status_summary,
target_identifier
FROM aws.controltower.enabled_baselines
WHERE region = '{{ region }}' -- required
;

list_enabled_baselines

Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources. For usage examples, see the Amazon Web Services Control Tower User Guide .

SELECT
arn,
baseline_identifier,
baseline_version,
drift_status_summary,
parent_identifier,
status_summary,
target_identifier
FROM aws.controltower.enabled_baselines
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_enabled_baseline

Updates an EnabledBaseline resource's applied parameters or version. For usage examples, see the Amazon Web Services Control Tower User Guide .

UPDATE aws.controltower.enabled_baselines
SET 
baselineVersion = '{{ baselineVersion }}',
parameters = '{{ parameters }}',
enabledBaselineIdentifier = '{{ enabledBaselineIdentifier }}'
WHERE 
region = '{{ region }}' --required
AND baselineVersion = '{{ baselineVersion }}' --required
AND enabledBaselineIdentifier = '{{ enabledBaselineIdentifier }}' --required
RETURNING
operation_identifier;

Lifecycle Methods

reset_enabled_baseline

Re-enables an EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU. For usage examples, see the Amazon Web Services Control Tower User Guide .

EXEC aws.controltower.enabled_baselines.reset_enabled_baseline 
@region='{{ region }}' --required 
@@json=
'{
"enabledBaselineIdentifier": "{{ enabledBaselineIdentifier }}"
}'
;