CfnConfigurationAggregatorPropsMixin

class aws_cdk.mixins_preview.aws_config.mixins.CfnConfigurationAggregatorPropsMixin(props, *, strategy=None)

Bases: Mixin

The details about the configuration aggregator, including information about source accounts, regions, and metadata of the aggregator.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationaggregator.html
CloudformationResource:: AWS::Config::ConfigurationAggregator
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_config import mixins as config_mixins

cfn_configuration_aggregator_props_mixin = config_mixins.CfnConfigurationAggregatorPropsMixin(config_mixins.CfnConfigurationAggregatorMixinProps(
    account_aggregation_sources=[config_mixins.CfnConfigurationAggregatorPropsMixin.AccountAggregationSourceProperty(
        account_ids=["accountIds"],
        all_aws_regions=False,
        aws_regions=["awsRegions"]
    )],
    configuration_aggregator_name="configurationAggregatorName",
    organization_aggregation_source=config_mixins.CfnConfigurationAggregatorPropsMixin.OrganizationAggregationSourceProperty(
        all_aws_regions=False,
        aws_regions=["awsRegions"],
        role_arn="roleArn"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Config::ConfigurationAggregator.

Parameters:

props (Union[CfnConfigurationAggregatorMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['accountAggregationSources', 'configurationAggregatorName', 'organizationAggregationSource', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AccountAggregationSourceProperty

class CfnConfigurationAggregatorPropsMixin.AccountAggregationSourceProperty(*, account_ids=None, all_aws_regions=None, aws_regions=None)

Bases: object

A collection of accounts and regions.

Parameters:

account_ids (Optional[Sequence[str]]) – The 12-digit account ID of the account being aggregated.
all_aws_regions (Union[bool, IResolvable, None]) – If true, aggregate existing AWS Config regions and future regions.
aws_regions (Optional[Sequence[str]]) – The source regions being aggregated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-accountaggregationsource.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_config import mixins as config_mixins

account_aggregation_source_property = config_mixins.CfnConfigurationAggregatorPropsMixin.AccountAggregationSourceProperty(
    account_ids=["accountIds"],
    all_aws_regions=False,
    aws_regions=["awsRegions"]
)

Attributes

account_ids

The 12-digit account ID of the account being aggregated.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-accountaggregationsource.html#cfn-config-configurationaggregator-accountaggregationsource-accountids

all_aws_regions

If true, aggregate existing AWS Config regions and future regions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-accountaggregationsource.html#cfn-config-configurationaggregator-accountaggregationsource-allawsregions

aws_regions

The source regions being aggregated.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-accountaggregationsource.html#cfn-config-configurationaggregator-accountaggregationsource-awsregions

OrganizationAggregationSourceProperty

class CfnConfigurationAggregatorPropsMixin.OrganizationAggregationSourceProperty(*, all_aws_regions=None, aws_regions=None, role_arn=None)

Bases: object

This object contains regions to set up the aggregator and an IAM role to retrieve organization details.

Parameters:

all_aws_regions (Union[bool, IResolvable, None]) – If true, aggregate existing AWS Config regions and future regions.
aws_regions (Optional[Sequence[str]]) – The source regions being aggregated.
role_arn (Optional[str]) – ARN of the IAM role used to retrieve AWS Organizations details associated with the aggregator account.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-organizationaggregationsource.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_config import mixins as config_mixins

organization_aggregation_source_property = config_mixins.CfnConfigurationAggregatorPropsMixin.OrganizationAggregationSourceProperty(
    all_aws_regions=False,
    aws_regions=["awsRegions"],
    role_arn="roleArn"
)

Attributes

all_aws_regions

If true, aggregate existing AWS Config regions and future regions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-organizationaggregationsource.html#cfn-config-configurationaggregator-organizationaggregationsource-allawsregions

aws_regions

The source regions being aggregated.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-organizationaggregationsource.html#cfn-config-configurationaggregator-organizationaggregationsource-awsregions

role_arn

ARN of the IAM role used to retrieve AWS Organizations details associated with the aggregator account.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationaggregator-organizationaggregationsource.html#cfn-config-configurationaggregator-organizationaggregationsource-rolearn