Put Configuration Aggregator

configservice_put_configuration_aggregator

R Documentation

Creates and updates the configuration aggregator with the selected source accounts and regions

Description

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 describe_configuration_aggregators 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

put_configuration_aggregator 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 tag_resource and untag_resource to update tags after creation.

Usage

configservice_put_configuration_aggregator(ConfigurationAggregatorName,
  AccountAggregationSources, OrganizationAggregationSource, Tags,
  AggregatorFilters)

Arguments

ConfigurationAggregatorName	[required] The name of the configuration aggregator.
AccountAggregationSources	A list of AccountAggregationSource object.
OrganizationAggregationSource	An OrganizationAggregationSource object.
Tags	An array of tag object.
AggregatorFilters	An object to filter configuration recorders in an aggregator. Either ResourceType or ServicePrincipal is required.

Value

A list with the following syntax:

list(
  ConfigurationAggregator = list(
    ConfigurationAggregatorName = "string",
    ConfigurationAggregatorArn = "string",
    AccountAggregationSources = list(
      list(
        AccountIds = list(
          "string"
        ),
        AllAwsRegions = TRUE|FALSE,
        AwsRegions = list(
          "string"
        )
      )
    ),
    OrganizationAggregationSource = list(
      RoleArn = "string",
      AwsRegions = list(
        "string"
      ),
      AllAwsRegions = TRUE|FALSE
    ),
    CreationTime = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdatedTime = as.POSIXct(
      "2015-01-01"
    ),
    CreatedBy = "string",
    AggregatorFilters = list(
      ResourceType = list(
        Type = "INCLUDE",
        Value = list(
          "string"
        )
      ),
      ServicePrincipal = list(
        Type = "INCLUDE",
        Value = list(
          "string"
        )
      )
    )
  )
)

Request syntax

svc$put_configuration_aggregator(
  ConfigurationAggregatorName = "string",
  AccountAggregationSources = list(
    list(
      AccountIds = list(
        "string"
      ),
      AllAwsRegions = TRUE|FALSE,
      AwsRegions = list(
        "string"
      )
    )
  ),
  OrganizationAggregationSource = list(
    RoleArn = "string",
    AwsRegions = list(
      "string"
    ),
    AllAwsRegions = TRUE|FALSE
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  AggregatorFilters = list(
    ResourceType = list(
      Type = "INCLUDE",
      Value = list(
        "string"
      )
    ),
    ServicePrincipal = list(
      Type = "INCLUDE",
      Value = list(
        "string"
      )
    )
  )
)