aggregation_authorizations
Creates, updates, deletes, gets or lists an aggregation_authorizations resource.
Overview
| Name | aggregation_authorizations |
| Type | Resource |
| Id | aws.config.aggregation_authorizations |
Fields
The following fields are returned by SELECT queries:
- describe_aggregation_authorizations
| Name | Datatype | Description |
|---|---|---|
aggregation_authorization_arn | string | The Amazon Resource Name (ARN) of the aggregation object. |
authorized_account_id | string | The 12-digit account ID of the account authorized to aggregate data. (pattern: <code>\d{12}</code>) |
authorized_aws_region | string | The region authorized to collect aggregated data. |
creation_time | string (date-time) | The time stamp when the aggregation authorization was created. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_aggregation_authorizations | select | region | Returns a list of authorizations granted to various aggregator accounts and regions. | |
put_aggregation_authorization | replace | region, AuthorizedAccountId, AuthorizedAwsRegion | Authorizes the aggregator account and region to collect data from the source account and region. Tags are added at creation and cannot be updated with this operation PutAggregationAuthorization 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_aggregation_authorization | delete | region | Deletes the authorization granted to the specified configuration aggregator account in a specified region. |
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_aggregation_authorizations
Returns a list of authorizations granted to various aggregator accounts and regions.
SELECT
aggregation_authorization_arn,
authorized_account_id,
authorized_aws_region,
creation_time
FROM aws.config.aggregation_authorizations
WHERE region = '{{ region }}' -- required
;
REPLACE examples
- put_aggregation_authorization
Authorizes the aggregator account and region to collect data from the source account and region. Tags are added at creation and cannot be updated with this operation PutAggregationAuthorization 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.aggregation_authorizations
SET
AuthorizedAccountId = '{{ AuthorizedAccountId }}',
AuthorizedAwsRegion = '{{ AuthorizedAwsRegion }}',
Tags = '{{ Tags }}'
WHERE
region = '{{ region }}' --required
AND AuthorizedAccountId = '{{ AuthorizedAccountId }}' --required
AND AuthorizedAwsRegion = '{{ AuthorizedAwsRegion }}' --required
RETURNING
aggregation_authorization;
DELETE examples
- delete_aggregation_authorization
Deletes the authorization granted to the specified configuration aggregator account in a specified region.
DELETE FROM aws.config.aggregation_authorizations
WHERE region = '{{ region }}' --required
;