configuration_aggregators

Creates, updates, deletes or gets a configuration_aggregator resource or lists configuration_aggregators in a region

Overview

Name	configuration_aggregators
Type	Resource
Description	Resource Type definition for AWS::Config::ConfigurationAggregator
Id	aws.config.configuration_aggregators

Fields

Name	Datatype	Description
account_aggregation_sources	array
configuration_aggregator_name	string	The name of the aggregator.
configuration_aggregator_arn	string	The Amazon Resource Name (ARN) of the aggregator.
organization_aggregation_source	object
tags	array	The tags for the configuration aggregator.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all configuration_aggregators in a region.

SELECT
region,
account_aggregation_sources,
configuration_aggregator_name,
configuration_aggregator_arn,
organization_aggregation_source,
tags
FROM aws.config.configuration_aggregators
WHERE region = 'us-east-1';

Gets all properties from an individual configuration_aggregator.

SELECT
region,
account_aggregation_sources,
configuration_aggregator_name,
configuration_aggregator_arn,
organization_aggregation_source,
tags
FROM aws.config.configuration_aggregators
WHERE region = 'us-east-1' AND data__Identifier = '<ConfigurationAggregatorName>';

INSERT example

Use the following StackQL query and manifest file to create a new configuration_aggregator resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.config.configuration_aggregators (
 AccountAggregationSources,
 ConfigurationAggregatorName,
 OrganizationAggregationSource,
 Tags,
 region
)
SELECT 
'{{ AccountAggregationSources }}',
 '{{ ConfigurationAggregatorName }}',
 '{{ OrganizationAggregationSource }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.config.configuration_aggregators (
 AccountAggregationSources,
 ConfigurationAggregatorName,
 OrganizationAggregationSource,
 Tags,
 region
)
SELECT 
 '{{ AccountAggregationSources }}',
 '{{ ConfigurationAggregatorName }}',
 '{{ OrganizationAggregationSource }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: configuration_aggregator
    props:
      - name: AccountAggregationSources
        value:
          - AllAwsRegions: '{{ AllAwsRegions }}'
            AwsRegions:
              - '{{ AwsRegions[0] }}'
            AccountIds:
              - '{{ AccountIds[0] }}'
      - name: ConfigurationAggregatorName
        value: '{{ ConfigurationAggregatorName }}'
      - name: OrganizationAggregationSource
        value:
          AllAwsRegions: '{{ AllAwsRegions }}'
          AwsRegions:
            - '{{ AwsRegions[0] }}'
          RoleArn: '{{ RoleArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.config.configuration_aggregators
WHERE data__Identifier = '<ConfigurationAggregatorName>'
AND region = 'us-east-1';

Permissions

To operate on the configuration_aggregators resource, the following permissions are required:

Create

config:PutConfigurationAggregator,
config:DescribeConfigurationAggregators,
config:TagResource,
iam:PassRole,
organizations:EnableAWSServiceAccess,
organizations:ListDelegatedAdministrators

Read

config:DescribeConfigurationAggregators,
config:ListTagsForResource

Update

config:PutConfigurationAggregator,
config:DescribeConfigurationAggregators,
config:TagResource,
config:UntagResource,
config:ListTagsForResource,
iam:PassRole,
organizations:EnableAWSServiceAccess,
organizations:ListDelegatedAdministrators

Delete

config:DeleteConfigurationAggregator,
config:UntagResource

List

config:DescribeConfigurationAggregators