configuration_aggregators

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

Overview

Name	`configuration_aggregators`
Type	Resource
Id	`aws.config.configuration_aggregators`

Fields

The following fields are returned by SELECT queries:

describe_configuration_aggregators

Name	Datatype	Description
`account_aggregation_sources`	`array`	Provides a list of source accounts and regions to be aggregated.
`aggregator_filters`	`object`	An object to filter the data you specify for an aggregator.
`configuration_aggregator_arn`	`string`	The Amazon Resource Name (ARN) of the aggregator. (pattern: <code>arn:aws[a-z-]*:config:[a-z-\d]+:\d+:config-aggregator/config-aggregator-[a-z\d]+</code>)
`configuration_aggregator_name`	`string`	The name of the aggregator. (pattern: <code>[\w-]+</code>)
`created_by`	`string`	Amazon Web Services service that created the configuration aggregator.
`creation_time`	`string (date-time)`	The time stamp when the configuration aggregator was created.
`last_updated_time`	`string (date-time)`	The time of the last update.
`organization_aggregation_source`	`object`	Provides an organization and list of regions to be aggregated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`describe_configuration_aggregators`	`select`	`region`	Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this operation returns the details for all the configuration aggregators associated with the account.
`put_configuration_aggregator`	`replace`	`region`, `ConfigurationAggregatorName`	Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization. accountIds that are passed will be replaced with existing accounts. If you want to add additional accounts into the aggregator, call DescribeConfigurationAggregators to get the previous accounts and then append new ones. Config should be enabled in source accounts and regions you want to aggregate. If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization. If the caller is a management account, Config calls EnableAwsServiceAccess API to enable integration between Config and Organizations. If the caller is a registered delegated administrator, Config calls ListDelegatedAdministrators API to verify whether the caller is a valid delegated administrator. To register a delegated administrator, see Register a Delegated Administrator in the Config developer guide. Tags are added at creation and cannot be updated with this operation PutConfigurationAggregator 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.
`delete_configuration_aggregator`	`delete`	`region`	Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
`select_aggregate_resource_config`	`exec`	`region`, `Expression`, `ConfigurationAggregatorName`	Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties. For more information about query components, see the Query Components section in the Config Developer Guide. If you run an aggregation query (i.e., using GROUP BY or using aggregate functions such as COUNT; e.g., SELECT resourceId, COUNT() WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId) and do not specify the MaxResults or the Limit query parameters, the default page size is set to 500. If you run a non-aggregation query (i.e., not using GROUP BY or aggregate function; e.g., SELECT WHERE resourceType = 'AWS::IAM::Role') and do not specify the MaxResults or the Limit query parameters, the default page size is set to 25.

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_aggregators

Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this operation returns the details for all the configuration aggregators associated with the account.

SELECT
account_aggregation_sources,
aggregator_filters,
configuration_aggregator_arn,
configuration_aggregator_name,
created_by,
creation_time,
last_updated_time,
organization_aggregation_source
FROM aws.config.configuration_aggregators
WHERE region = '{{ region }}' -- required
;

`REPLACE` examples

put_configuration_aggregator

Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization. accountIds that are passed will be replaced with existing accounts. If you want to add additional accounts into the aggregator, call DescribeConfigurationAggregators to get the previous accounts and then append new ones. Config should be enabled in source accounts and regions you want to aggregate. If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization. If the caller is a management account, Config calls EnableAwsServiceAccess API to enable integration between Config and Organizations. If the caller is a registered delegated administrator, Config calls ListDelegatedAdministrators API to verify whether the caller is a valid delegated administrator. To register a delegated administrator, see Register a Delegated Administrator in the Config developer guide. Tags are added at creation and cannot be updated with this operation PutConfigurationAggregator 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_aggregators
SET 
ConfigurationAggregatorName = '{{ ConfigurationAggregatorName }}',
AccountAggregationSources = '{{ AccountAggregationSources }}',
OrganizationAggregationSource = '{{ OrganizationAggregationSource }}',
Tags = '{{ Tags }}',
AggregatorFilters = '{{ AggregatorFilters }}'
WHERE 
region = '{{ region }}' --required
AND ConfigurationAggregatorName = '{{ ConfigurationAggregatorName }}' --required
RETURNING
configuration_aggregator;

`DELETE` examples

delete_configuration_aggregator

Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.

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

Lifecycle Methods

select_aggregate_resource_config

Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties. For more information about query components, see the Query Components section in the Config Developer Guide. If you run an aggregation query (i.e., using GROUP BY or using aggregate functions such as COUNT; e.g., SELECT resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId) and do not specify the MaxResults or the Limit query parameters, the default page size is set to 500. If you run a non-aggregation query (i.e., not using GROUP BY or aggregate function; e.g., SELECT * WHERE resourceType = 'AWS::IAM::Role') and do not specify the MaxResults or the Limit query parameters, the default page size is set to 25.

EXEC aws.config.configuration_aggregators.select_aggregate_resource_config 
@region='{{ region }}' --required 
@@json=
'{
"Expression": "{{ Expression }}", 
"ConfigurationAggregatorName": "{{ ConfigurationAggregatorName }}", 
"Limit": {{ Limit }}, 
"MaxResults": {{ MaxResults }}, 
"NextToken": "{{ NextToken }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

REPLACE examples​

DELETE examples​

Lifecycle Methods​