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	awscc.config.configuration_aggregators

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
configuration_aggregator_name	string	The name of the aggregator.
region	string	AWS region.

For more information, see AWS::Config::ConfigurationAggregator.

Methods

Name	Resource	Accessible by	Required Params
create_resource	configuration_aggregators	INSERT	region
delete_resource	configuration_aggregators	DELETE	Identifier, region
update_resource	configuration_aggregators	UPDATE	Identifier, PatchDocument, region
list_resources	configuration_aggregators_list_only	SELECT	region
get_resource	configuration_aggregators	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual configuration_aggregator.

SELECT
  region,
  account_aggregation_sources,
  configuration_aggregator_name,
  configuration_aggregator_arn,
  organization_aggregation_source,
  tags
FROM awscc.config.configuration_aggregators
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ configuration_aggregator_name }}';

list (identifiers only)

Lists all configuration_aggregators in a region.

SELECT
  region,
  configuration_aggregator_name
FROM awscc.config.configuration_aggregators_list_only
WHERE
  region = 'us-east-1';

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 awscc.config.configuration_aggregators (
  AccountAggregationSources,
  ConfigurationAggregatorName,
  OrganizationAggregationSource,
  Tags,
  region
)
SELECT
  '{{ account_aggregation_sources }}',
  '{{ configuration_aggregator_name }}',
  '{{ organization_aggregation_source }}',
  '{{ tags }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.config.configuration_aggregators (
  AccountAggregationSources,
  ConfigurationAggregatorName,
  OrganizationAggregationSource,
  Tags,
  region
)
SELECT
  '{{ account_aggregation_sources }}',
  '{{ configuration_aggregator_name }}',
  '{{ organization_aggregation_source }}',
  '{{ 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: account_aggregation_sources
        value:
          - all_aws_regions: '{{ all_aws_regions }}'
            aws_regions:
              - '{{ aws_regions[0] }}'
            account_ids:
              - '{{ account_ids[0] }}'
      - name: configuration_aggregator_name
        value: '{{ configuration_aggregator_name }}'
      - name: organization_aggregation_source
        value:
          all_aws_regions: '{{ all_aws_regions }}'
          aws_regions:
            - '{{ aws_regions[0] }}'
          role_arn: '{{ role_arn }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.config.configuration_aggregators
SET PatchDocument = string('{{ {
    "AccountAggregationSources": account_aggregation_sources,
    "OrganizationAggregationSource": organization_aggregation_source,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ configuration_aggregator_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.config.configuration_aggregators
WHERE
  Identifier = '{{ configuration_aggregator_name }}' 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