configuration_aggregator#

State module for managing Amazon Configuration Aggregator.

async idem_aws.states.aws.config.configuration_aggregator.present(hub, ctx, name: str, resource_id: str = None, account_aggregation_sources: List[AccountAggregationSource] = None, organization_aggregation_source: OrganizationAggregationSource = None, tags: List[Tag] = None) → Dict[str, Any][source]#

Creates an Amazon Configuration Aggregator.

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

Parameters:

  • name (str) – An Idem name of the resource.

  • resource_id (str, Optional) – An identifier of the resource in the provider, a name of Configuration Aggregator. Defaults to None.

  • account_aggregation_sources (List[Dict[str, Any]], Optional) –

    A list of AccountAggregationSource object. Defaults to None.

    • AccountIds (List[str]): The 12-digit account ID of the account being aggregated.

    • AllAwsRegions (bool, optional): If true, aggregate existing Config regions and future regions.

    • AwsRegions (List[str], optional): The source regions being aggregated.

  • organization_aggregation_source (Dict[str, Any], Optional) –

    An OrganizationAggregationSource object. Defaults to None.

    • RoleArn (str): ARN of the IAM role.

    • AwsRegions (List[str], optional): The source regions being aggregated.

    • AllAwsRegions (bool, optional): If true, aggregate existing Config regions and future regions.

  • tags (List[Dict[str, Any]], Optional) – An array of tag object. Defaults to None. * Key (str, optional): One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values. * Value (str, optional): The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Request Syntax:
aws.config.configuration_aggregator.present:

  • name: ‘string’

  • resource_id: ‘string’

  • account_aggregation_sources:
    • AccountIds:

      • ‘string’

      AllAwsRegions: True|False AwsRegions:

      • ‘string’

organization_aggregation_source:

  • RoleArn: ‘string’ AwsRegions:

    • ‘string’

    AwsRegions: True|False

Returns:

Dict[str, Any]

Examples

resource_is_present:
  aws.config.configuration_aggregator.present:
    - name: value
async idem_aws.states.aws.config.configuration_aggregator.absent(hub, ctx, name: str, resource_id: str = None) → Dict[str, Any][source]#

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

Parameters:

  • name (str) – An Idem name of the resource.

  • resource_id (str, Optional) – An identifier of the resource in the provider.

Request Syntax:
aws.config.configuration_aggregator.absent:

  • name: ‘string’

  • resource_id: ‘string’

Returns:

Dict[str, Any]

Examples

resource_is_absent:
  aws.config.configuration_aggregator.absent:
    - name: value
    - resource_id: value
async idem_aws.states.aws.config.configuration_aggregator.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Describe the resource in a way that can be recreated/managed with the corresponding “present” function.

Examples

$ idem describe aws.config.configuration_aggregator