configuration_recorders

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

Overview

Name	configuration_recorders
Type	Resource
Id	aws.config.configuration_recorders

Fields

The following fields are returned by SELECT queries:

describe_configuration_recorders

Name	Datatype	Description
configuration_recorders	array	A list that contains the descriptions of the specified configuration recorders.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_configuration_recorders	select	region		Returns details for the configuration recorder you specify. If a configuration recorder is not specified, this operation returns details for the customer managed configuration recorder configured for the account, if applicable. When making a request to this operation, you can only specify one configuration recorder.
associate_resource_types	update	region, ConfigurationRecorderArn, ResourceTypes		Adds all resource types specified in the ResourceTypes list to the RecordingGroup of specified configuration recorder and includes those resource types when recording. For this operation, the specified configuration recorder must use a RecordingStrategy that is either INCLUSION_BY_RESOURCE_TYPES or EXCLUSION_BY_RESOURCE_TYPES.
put_third_party_service_linked_configuration_recorder	replace	region, ServicePrincipal, ConnectorArn, ScopeConfiguration		Creates or updates a service-linked configuration recorder that is linked to a third-party cloud service provider based on the ConnectorArn you specify. The configuration recorder's name, recordingGroup, recordingMode, and recordingScope is set by the service that is linked to the configuration recorder. If a service-linked configuration recorder already exists for the specified service principal and connector, calling this operation again updates the ScopeConfiguration. This operation can only be called by the Amazon Web Services service linked to the configuration recorder Customers cannot call this operation directly. Only the linked Amazon Web Services service can create or update the service-linked configuration recorder. Tags are added at creation and cannot be updated with this operation Use TagResource and UntagResource to update tags after creation.
put_configuration_recorder	replace	region, ConfigurationRecorder		Creates or updates the customer managed configuration recorder. You can use this operation to create a new customer managed configuration recorder or to update the roleARN and the recordingGroup for an existing customer managed configuration recorder. To start the customer managed configuration recorder and begin recording configuration changes for the resource types you specify, use the StartConfigurationRecorder operation. For more information, see Working with the Configuration Recorder in the Config Developer Guide. One customer managed configuration recorder per account per Region You can create only one customer managed configuration recorder for each account for each Amazon Web Services Region. Default is to record all supported resource types, excluding the global IAM resource types If you have not specified values for the recordingGroup field, the default for the customer managed configuration recorder is to record all supported resource types, excluding the global IAM resource types: AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::Role, and AWS::IAM::User. Tags are added at creation and cannot be updated PutConfigurationRecorder is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different. Use TagResource and UntagResource to update tags after creation.
put_service_linked_configuration_recorder	replace	region, ServicePrincipal		Creates a service-linked configuration recorder that is linked to a specific Amazon Web Services service based on the ServicePrincipal you specify. The configuration recorder's name, recordingGroup, recordingMode, and recordingScope is set by the service that is linked to the configuration recorder. For more information and a list of supported services/service principals, see Working with the Configuration Recorder in the Config Developer Guide. This API creates a service-linked role AWSServiceRoleForConfig in your account. The service-linked role is created only when the role does not exist in your account. The recording scope determines if you receive configuration items The recording scope is set by the service that is linked to the configuration recorder and determines whether you receive configuration items (CIs) in the delivery channel. If the recording scope is internal, you will not receive CIs in the delivery channel. Tags are added at creation and cannot be updated with this operation Use TagResource and UntagResource to update tags after creation.
delete_configuration_recorder	delete	region		Deletes the customer managed configuration recorder. This operation does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory operation, but you will not be able to access this information in the Config console until you have created a new customer managed configuration recorder.
delete_service_linked_configuration_recorder	delete	region		Deletes an existing service-linked configuration recorder. This operation does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory operation, but you will not be able to access this information in the Config console until you have created a new service-linked configuration recorder for the same service. The recording scope determines if you receive configuration items The recording scope is set by the service that is linked to the configuration recorder and determines whether you receive configuration items (CIs) in the delivery channel. If the recording scope is internal, you will not receive CIs in the delivery channel.
disassociate_resource_types	exec	region, ConfigurationRecorderArn, ResourceTypes		Removes all resource types specified in the ResourceTypes list from the RecordingGroup of configuration recorder and excludes these resource types when recording. For this operation, the configuration recorder must use a RecordingStrategy that is either INCLUSION_BY_RESOURCE_TYPES or EXCLUSION_BY_RESOURCE_TYPES.
list_configuration_recorders	exec	region		Returns a list of configuration recorders depending on the filters you specify.
start_configuration_recorder	exec	region, ConfigurationRecorderName		Starts the customer managed configuration recorder. The customer managed configuration recorder will begin recording configuration changes for the resource types you specify. You must have created a delivery channel to successfully start the customer managed configuration recorder. You can use the PutDeliveryChannel operation to create a delivery channel.
stop_configuration_recorder	exec	region, ConfigurationRecorderName		Stops the customer managed configuration recorder. The customer managed configuration recorder will stop recording configuration changes for the resource types you have specified.

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

describe_configuration_recorders

Returns details for the configuration recorder you specify. If a configuration recorder is not specified, this operation returns details for the customer managed configuration recorder configured for the account, if applicable. When making a request to this operation, you can only specify one configuration recorder.

SELECT
configuration_recorders
FROM aws.config.configuration_recorders
WHERE region = '{{ region }}' -- required
;

UPDATE examples

associate_resource_types

Adds all resource types specified in the ResourceTypes list to the RecordingGroup of specified configuration recorder and includes those resource types when recording. For this operation, the specified configuration recorder must use a RecordingStrategy that is either INCLUSION_BY_RESOURCE_TYPES or EXCLUSION_BY_RESOURCE_TYPES.

UPDATE aws.config.configuration_recorders
SET 
ConfigurationRecorderArn = '{{ ConfigurationRecorderArn }}',
ResourceTypes = '{{ ResourceTypes }}'
WHERE 
region = '{{ region }}' --required
AND ConfigurationRecorderArn = '{{ ConfigurationRecorderArn }}' --required
AND ResourceTypes = '{{ ResourceTypes }}' --required
RETURNING
configuration_recorder;

REPLACE examples

put_third_party_service_linked_configuration_recorder

Creates or updates a service-linked configuration recorder that is linked to a third-party cloud service provider based on the ConnectorArn you specify. The configuration recorder's name, recordingGroup, recordingMode, and recordingScope is set by the service that is linked to the configuration recorder. If a service-linked configuration recorder already exists for the specified service principal and connector, calling this operation again updates the ScopeConfiguration. This operation can only be called by the Amazon Web Services service linked to the configuration recorder Customers cannot call this operation directly. Only the linked Amazon Web Services service can create or update the service-linked configuration recorder. Tags are added at creation and cannot be updated with this operation Use TagResource and UntagResource to update tags after creation.

REPLACE aws.config.configuration_recorders
SET 
ServicePrincipal = '{{ ServicePrincipal }}',
ConnectorArn = '{{ ConnectorArn }}',
ScopeConfiguration = '{{ ScopeConfiguration }}',
Tags = '{{ Tags }}'
WHERE 
region = '{{ region }}' --required
AND ServicePrincipal = '{{ ServicePrincipal }}' --required
AND ConnectorArn = '{{ ConnectorArn }}' --required
AND ScopeConfiguration = '{{ ScopeConfiguration }}' --required
RETURNING
arn,
name;

put_configuration_recorder

Creates or updates the customer managed configuration recorder. You can use this operation to create a new customer managed configuration recorder or to update the roleARN and the recordingGroup for an existing customer managed configuration recorder. To start the customer managed configuration recorder and begin recording configuration changes for the resource types you specify, use the StartConfigurationRecorder operation. For more information, see Working with the Configuration Recorder in the Config Developer Guide. One customer managed configuration recorder per account per Region You can create only one customer managed configuration recorder for each account for each Amazon Web Services Region. Default is to record all supported resource types, excluding the global IAM resource types If you have not specified values for the recordingGroup field, the default for the customer managed configuration recorder is to record all supported resource types, excluding the global IAM resource types: AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::Role, and AWS::IAM::User. Tags are added at creation and cannot be updated PutConfigurationRecorder is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different. Use TagResource and UntagResource to update tags after creation.

REPLACE aws.config.configuration_recorders
SET 
ConfigurationRecorder = '{{ ConfigurationRecorder }}',
Tags = '{{ Tags }}'
WHERE 
region = '{{ region }}' --required
AND ConfigurationRecorder = '{{ ConfigurationRecorder }}' --required;

put_service_linked_configuration_recorder

Creates a service-linked configuration recorder that is linked to a specific Amazon Web Services service based on the ServicePrincipal you specify. The configuration recorder's name, recordingGroup, recordingMode, and recordingScope is set by the service that is linked to the configuration recorder. For more information and a list of supported services/service principals, see Working with the Configuration Recorder in the Config Developer Guide. This API creates a service-linked role AWSServiceRoleForConfig in your account. The service-linked role is created only when the role does not exist in your account. The recording scope determines if you receive configuration items The recording scope is set by the service that is linked to the configuration recorder and determines whether you receive configuration items (CIs) in the delivery channel. If the recording scope is internal, you will not receive CIs in the delivery channel. Tags are added at creation and cannot be updated with this operation Use TagResource and UntagResource to update tags after creation.

REPLACE aws.config.configuration_recorders
SET 
ServicePrincipal = '{{ ServicePrincipal }}',
Tags = '{{ Tags }}'
WHERE 
region = '{{ region }}' --required
AND ServicePrincipal = '{{ ServicePrincipal }}' --required
RETURNING
arn,
name;

DELETE examples

delete_configuration_recorder

Deletes the customer managed configuration recorder. This operation does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory operation, but you will not be able to access this information in the Config console until you have created a new customer managed configuration recorder.

DELETE FROM aws.config.configuration_recorders
WHERE region = '{{ region }}' --required
;

delete_service_linked_configuration_recorder

Deletes an existing service-linked configuration recorder. This operation does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory operation, but you will not be able to access this information in the Config console until you have created a new service-linked configuration recorder for the same service. The recording scope determines if you receive configuration items The recording scope is set by the service that is linked to the configuration recorder and determines whether you receive configuration items (CIs) in the delivery channel. If the recording scope is internal, you will not receive CIs in the delivery channel.

DELETE FROM aws.config.configuration_recorders
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

disassociate_resource_types

Removes all resource types specified in the ResourceTypes list from the RecordingGroup of configuration recorder and excludes these resource types when recording. For this operation, the configuration recorder must use a RecordingStrategy that is either INCLUSION_BY_RESOURCE_TYPES or EXCLUSION_BY_RESOURCE_TYPES.

EXEC aws.config.configuration_recorders.disassociate_resource_types 
@region='{{ region }}' --required 
@@json=
'{
"ConfigurationRecorderArn": "{{ ConfigurationRecorderArn }}", 
"ResourceTypes": "{{ ResourceTypes }}"
}'
;

list_configuration_recorders

Returns a list of configuration recorders depending on the filters you specify.

EXEC aws.config.configuration_recorders.list_configuration_recorders 
@region='{{ region }}' --required 
@@json=
'{
"Filters": "{{ Filters }}", 
"MaxResults": {{ MaxResults }}, 
"NextToken": "{{ NextToken }}"
}'
;

start_configuration_recorder

Starts the customer managed configuration recorder. The customer managed configuration recorder will begin recording configuration changes for the resource types you specify. You must have created a delivery channel to successfully start the customer managed configuration recorder. You can use the PutDeliveryChannel operation to create a delivery channel.

EXEC aws.config.configuration_recorders.start_configuration_recorder 
@region='{{ region }}' --required 
@@json=
'{
"ConfigurationRecorderName": "{{ ConfigurationRecorderName }}"
}'
;

stop_configuration_recorder

Stops the customer managed configuration recorder. The customer managed configuration recorder will stop recording configuration changes for the resource types you have specified.

EXEC aws.config.configuration_recorders.stop_configuration_recorder 
@region='{{ region }}' --required 
@@json=
'{
"ConfigurationRecorderName": "{{ ConfigurationRecorderName }}"
}'
;