1. Packages
  2. AWS Classic
  3. API Docs
  4. cfg
  5. ConfigurationAggregator

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

aws.cfg.ConfigurationAggregator

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

    Manages an AWS Config Configuration Aggregator

    Example Usage

    Account Based Aggregation

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const account = new aws.cfg.ConfigurationAggregator("account", {
        name: "example",
        accountAggregationSource: {
            accountIds: ["123456789012"],
            regions: ["us-west-2"],
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    account = aws.cfg.ConfigurationAggregator("account",
        name="example",
        account_aggregation_source=aws.cfg.ConfigurationAggregatorAccountAggregationSourceArgs(
            account_ids=["123456789012"],
            regions=["us-west-2"],
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cfg"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cfg.NewConfigurationAggregator(ctx, "account", &cfg.ConfigurationAggregatorArgs{
    			Name: pulumi.String("example"),
    			AccountAggregationSource: &cfg.ConfigurationAggregatorAccountAggregationSourceArgs{
    				AccountIds: pulumi.StringArray{
    					pulumi.String("123456789012"),
    				},
    				Regions: pulumi.StringArray{
    					pulumi.String("us-west-2"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var account = new Aws.Cfg.ConfigurationAggregator("account", new()
        {
            Name = "example",
            AccountAggregationSource = new Aws.Cfg.Inputs.ConfigurationAggregatorAccountAggregationSourceArgs
            {
                AccountIds = new[]
                {
                    "123456789012",
                },
                Regions = new[]
                {
                    "us-west-2",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.cfg.ConfigurationAggregator;
    import com.pulumi.aws.cfg.ConfigurationAggregatorArgs;
    import com.pulumi.aws.cfg.inputs.ConfigurationAggregatorAccountAggregationSourceArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var account = new ConfigurationAggregator("account", ConfigurationAggregatorArgs.builder()
                .name("example")
                .accountAggregationSource(ConfigurationAggregatorAccountAggregationSourceArgs.builder()
                    .accountIds("123456789012")
                    .regions("us-west-2")
                    .build())
                .build());
    
        }
    }
    
    resources:
      account:
        type: aws:cfg:ConfigurationAggregator
        properties:
          name: example
          accountAggregationSource:
            accountIds:
              - '123456789012'
            regions:
              - us-west-2
    

    Organization Based Aggregation

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const assumeRole = aws.iam.getPolicyDocument({
        statements: [{
            effect: "Allow",
            principals: [{
                type: "Service",
                identifiers: ["config.amazonaws.com"],
            }],
            actions: ["sts:AssumeRole"],
        }],
    });
    const organizationRole = new aws.iam.Role("organization", {
        name: "example",
        assumeRolePolicy: assumeRole.then(assumeRole => assumeRole.json),
    });
    const organizationRolePolicyAttachment = new aws.iam.RolePolicyAttachment("organization", {
        role: organizationRole.name,
        policyArn: "arn:aws:iam::aws:policy/service-role/AWSConfigRoleForOrganizations",
    });
    const organization = new aws.cfg.ConfigurationAggregator("organization", {
        name: "example",
        organizationAggregationSource: {
            allRegions: true,
            roleArn: organizationRole.arn,
        },
    }, {
        dependsOn: [organizationRolePolicyAttachment],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    assume_role = aws.iam.get_policy_document(statements=[aws.iam.GetPolicyDocumentStatementArgs(
        effect="Allow",
        principals=[aws.iam.GetPolicyDocumentStatementPrincipalArgs(
            type="Service",
            identifiers=["config.amazonaws.com"],
        )],
        actions=["sts:AssumeRole"],
    )])
    organization_role = aws.iam.Role("organization",
        name="example",
        assume_role_policy=assume_role.json)
    organization_role_policy_attachment = aws.iam.RolePolicyAttachment("organization",
        role=organization_role.name,
        policy_arn="arn:aws:iam::aws:policy/service-role/AWSConfigRoleForOrganizations")
    organization = aws.cfg.ConfigurationAggregator("organization",
        name="example",
        organization_aggregation_source=aws.cfg.ConfigurationAggregatorOrganizationAggregationSourceArgs(
            all_regions=True,
            role_arn=organization_role.arn,
        ),
        opts=pulumi.ResourceOptions(depends_on=[organization_role_policy_attachment]))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cfg"
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		assumeRole, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
    			Statements: []iam.GetPolicyDocumentStatement{
    				{
    					Effect: pulumi.StringRef("Allow"),
    					Principals: []iam.GetPolicyDocumentStatementPrincipal{
    						{
    							Type: "Service",
    							Identifiers: []string{
    								"config.amazonaws.com",
    							},
    						},
    					},
    					Actions: []string{
    						"sts:AssumeRole",
    					},
    				},
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		organizationRole, err := iam.NewRole(ctx, "organization", &iam.RoleArgs{
    			Name:             pulumi.String("example"),
    			AssumeRolePolicy: pulumi.String(assumeRole.Json),
    		})
    		if err != nil {
    			return err
    		}
    		organizationRolePolicyAttachment, err := iam.NewRolePolicyAttachment(ctx, "organization", &iam.RolePolicyAttachmentArgs{
    			Role:      organizationRole.Name,
    			PolicyArn: pulumi.String("arn:aws:iam::aws:policy/service-role/AWSConfigRoleForOrganizations"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = cfg.NewConfigurationAggregator(ctx, "organization", &cfg.ConfigurationAggregatorArgs{
    			Name: pulumi.String("example"),
    			OrganizationAggregationSource: &cfg.ConfigurationAggregatorOrganizationAggregationSourceArgs{
    				AllRegions: pulumi.Bool(true),
    				RoleArn:    organizationRole.Arn,
    			},
    		}, pulumi.DependsOn([]pulumi.Resource{
    			organizationRolePolicyAttachment,
    		}))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var assumeRole = Aws.Iam.GetPolicyDocument.Invoke(new()
        {
            Statements = new[]
            {
                new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
                {
                    Effect = "Allow",
                    Principals = new[]
                    {
                        new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
                        {
                            Type = "Service",
                            Identifiers = new[]
                            {
                                "config.amazonaws.com",
                            },
                        },
                    },
                    Actions = new[]
                    {
                        "sts:AssumeRole",
                    },
                },
            },
        });
    
        var organizationRole = new Aws.Iam.Role("organization", new()
        {
            Name = "example",
            AssumeRolePolicy = assumeRole.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
        });
    
        var organizationRolePolicyAttachment = new Aws.Iam.RolePolicyAttachment("organization", new()
        {
            Role = organizationRole.Name,
            PolicyArn = "arn:aws:iam::aws:policy/service-role/AWSConfigRoleForOrganizations",
        });
    
        var organization = new Aws.Cfg.ConfigurationAggregator("organization", new()
        {
            Name = "example",
            OrganizationAggregationSource = new Aws.Cfg.Inputs.ConfigurationAggregatorOrganizationAggregationSourceArgs
            {
                AllRegions = true,
                RoleArn = organizationRole.Arn,
            },
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                organizationRolePolicyAttachment,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.iam.IamFunctions;
    import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
    import com.pulumi.aws.iam.Role;
    import com.pulumi.aws.iam.RoleArgs;
    import com.pulumi.aws.iam.RolePolicyAttachment;
    import com.pulumi.aws.iam.RolePolicyAttachmentArgs;
    import com.pulumi.aws.cfg.ConfigurationAggregator;
    import com.pulumi.aws.cfg.ConfigurationAggregatorArgs;
    import com.pulumi.aws.cfg.inputs.ConfigurationAggregatorOrganizationAggregationSourceArgs;
    import com.pulumi.resources.CustomResourceOptions;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var assumeRole = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
                .statements(GetPolicyDocumentStatementArgs.builder()
                    .effect("Allow")
                    .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                        .type("Service")
                        .identifiers("config.amazonaws.com")
                        .build())
                    .actions("sts:AssumeRole")
                    .build())
                .build());
    
            var organizationRole = new Role("organizationRole", RoleArgs.builder()
                .name("example")
                .assumeRolePolicy(assumeRole.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult.json()))
                .build());
    
            var organizationRolePolicyAttachment = new RolePolicyAttachment("organizationRolePolicyAttachment", RolePolicyAttachmentArgs.builder()
                .role(organizationRole.name())
                .policyArn("arn:aws:iam::aws:policy/service-role/AWSConfigRoleForOrganizations")
                .build());
    
            var organization = new ConfigurationAggregator("organization", ConfigurationAggregatorArgs.builder()
                .name("example")
                .organizationAggregationSource(ConfigurationAggregatorOrganizationAggregationSourceArgs.builder()
                    .allRegions(true)
                    .roleArn(organizationRole.arn())
                    .build())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(organizationRolePolicyAttachment)
                    .build());
    
        }
    }
    
    resources:
      organization:
        type: aws:cfg:ConfigurationAggregator
        properties:
          name: example
          organizationAggregationSource:
            allRegions: true
            roleArn: ${organizationRole.arn}
        options:
          dependson:
            - ${organizationRolePolicyAttachment}
      organizationRole:
        type: aws:iam:Role
        name: organization
        properties:
          name: example
          assumeRolePolicy: ${assumeRole.json}
      organizationRolePolicyAttachment:
        type: aws:iam:RolePolicyAttachment
        name: organization
        properties:
          role: ${organizationRole.name}
          policyArn: arn:aws:iam::aws:policy/service-role/AWSConfigRoleForOrganizations
    variables:
      assumeRole:
        fn::invoke:
          Function: aws:iam:getPolicyDocument
          Arguments:
            statements:
              - effect: Allow
                principals:
                  - type: Service
                    identifiers:
                      - config.amazonaws.com
                actions:
                  - sts:AssumeRole
    

    Create ConfigurationAggregator Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ConfigurationAggregator(name: string, args?: ConfigurationAggregatorArgs, opts?: CustomResourceOptions);
    @overload
    def ConfigurationAggregator(resource_name: str,
                                args: Optional[ConfigurationAggregatorArgs] = None,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def ConfigurationAggregator(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                account_aggregation_source: Optional[ConfigurationAggregatorAccountAggregationSourceArgs] = None,
                                name: Optional[str] = None,
                                organization_aggregation_source: Optional[ConfigurationAggregatorOrganizationAggregationSourceArgs] = None,
                                tags: Optional[Mapping[str, str]] = None)
    func NewConfigurationAggregator(ctx *Context, name string, args *ConfigurationAggregatorArgs, opts ...ResourceOption) (*ConfigurationAggregator, error)
    public ConfigurationAggregator(string name, ConfigurationAggregatorArgs? args = null, CustomResourceOptions? opts = null)
    public ConfigurationAggregator(String name, ConfigurationAggregatorArgs args)
    public ConfigurationAggregator(String name, ConfigurationAggregatorArgs args, CustomResourceOptions options)
    
    type: aws:cfg:ConfigurationAggregator
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ConfigurationAggregatorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ConfigurationAggregatorArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ConfigurationAggregatorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConfigurationAggregatorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConfigurationAggregatorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var configurationAggregatorResource = new Aws.Cfg.ConfigurationAggregator("configurationAggregatorResource", new()
    {
        AccountAggregationSource = new Aws.Cfg.Inputs.ConfigurationAggregatorAccountAggregationSourceArgs
        {
            AccountIds = new[]
            {
                "string",
            },
            AllRegions = false,
            Regions = new[]
            {
                "string",
            },
        },
        Name = "string",
        OrganizationAggregationSource = new Aws.Cfg.Inputs.ConfigurationAggregatorOrganizationAggregationSourceArgs
        {
            RoleArn = "string",
            AllRegions = false,
            Regions = new[]
            {
                "string",
            },
        },
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := cfg.NewConfigurationAggregator(ctx, "configurationAggregatorResource", &cfg.ConfigurationAggregatorArgs{
    	AccountAggregationSource: &cfg.ConfigurationAggregatorAccountAggregationSourceArgs{
    		AccountIds: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		AllRegions: pulumi.Bool(false),
    		Regions: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	Name: pulumi.String("string"),
    	OrganizationAggregationSource: &cfg.ConfigurationAggregatorOrganizationAggregationSourceArgs{
    		RoleArn:    pulumi.String("string"),
    		AllRegions: pulumi.Bool(false),
    		Regions: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var configurationAggregatorResource = new ConfigurationAggregator("configurationAggregatorResource", ConfigurationAggregatorArgs.builder()
        .accountAggregationSource(ConfigurationAggregatorAccountAggregationSourceArgs.builder()
            .accountIds("string")
            .allRegions(false)
            .regions("string")
            .build())
        .name("string")
        .organizationAggregationSource(ConfigurationAggregatorOrganizationAggregationSourceArgs.builder()
            .roleArn("string")
            .allRegions(false)
            .regions("string")
            .build())
        .tags(Map.of("string", "string"))
        .build());
    
    configuration_aggregator_resource = aws.cfg.ConfigurationAggregator("configurationAggregatorResource",
        account_aggregation_source=aws.cfg.ConfigurationAggregatorAccountAggregationSourceArgs(
            account_ids=["string"],
            all_regions=False,
            regions=["string"],
        ),
        name="string",
        organization_aggregation_source=aws.cfg.ConfigurationAggregatorOrganizationAggregationSourceArgs(
            role_arn="string",
            all_regions=False,
            regions=["string"],
        ),
        tags={
            "string": "string",
        })
    
    const configurationAggregatorResource = new aws.cfg.ConfigurationAggregator("configurationAggregatorResource", {
        accountAggregationSource: {
            accountIds: ["string"],
            allRegions: false,
            regions: ["string"],
        },
        name: "string",
        organizationAggregationSource: {
            roleArn: "string",
            allRegions: false,
            regions: ["string"],
        },
        tags: {
            string: "string",
        },
    });
    
    type: aws:cfg:ConfigurationAggregator
    properties:
        accountAggregationSource:
            accountIds:
                - string
            allRegions: false
            regions:
                - string
        name: string
        organizationAggregationSource:
            allRegions: false
            regions:
                - string
            roleArn: string
        tags:
            string: string
    

    ConfigurationAggregator Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ConfigurationAggregator resource accepts the following input properties:

    AccountAggregationSource ConfigurationAggregatorAccountAggregationSource
    The account(s) to aggregate config data from as documented below.
    Name string
    The name of the configuration aggregator.
    OrganizationAggregationSource ConfigurationAggregatorOrganizationAggregationSource
    The organization to aggregate config data from as documented below.
    Tags Dictionary<string, string>

    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Either account_aggregation_source or organization_aggregation_source must be specified.

    AccountAggregationSource ConfigurationAggregatorAccountAggregationSourceArgs
    The account(s) to aggregate config data from as documented below.
    Name string
    The name of the configuration aggregator.
    OrganizationAggregationSource ConfigurationAggregatorOrganizationAggregationSourceArgs
    The organization to aggregate config data from as documented below.
    Tags map[string]string

    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Either account_aggregation_source or organization_aggregation_source must be specified.

    accountAggregationSource ConfigurationAggregatorAccountAggregationSource
    The account(s) to aggregate config data from as documented below.
    name String
    The name of the configuration aggregator.
    organizationAggregationSource ConfigurationAggregatorOrganizationAggregationSource
    The organization to aggregate config data from as documented below.
    tags Map<String,String>

    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Either account_aggregation_source or organization_aggregation_source must be specified.

    accountAggregationSource ConfigurationAggregatorAccountAggregationSource
    The account(s) to aggregate config data from as documented below.
    name string
    The name of the configuration aggregator.
    organizationAggregationSource ConfigurationAggregatorOrganizationAggregationSource
    The organization to aggregate config data from as documented below.
    tags {[key: string]: string}

    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Either account_aggregation_source or organization_aggregation_source must be specified.

    account_aggregation_source ConfigurationAggregatorAccountAggregationSourceArgs
    The account(s) to aggregate config data from as documented below.
    name str
    The name of the configuration aggregator.
    organization_aggregation_source ConfigurationAggregatorOrganizationAggregationSourceArgs
    The organization to aggregate config data from as documented below.
    tags Mapping[str, str]

    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Either account_aggregation_source or organization_aggregation_source must be specified.

    accountAggregationSource Property Map
    The account(s) to aggregate config data from as documented below.
    name String
    The name of the configuration aggregator.
    organizationAggregationSource Property Map
    The organization to aggregate config data from as documented below.
    tags Map<String>

    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Either account_aggregation_source or organization_aggregation_source must be specified.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ConfigurationAggregator resource produces the following output properties:

    Arn string
    The ARN of the aggregator
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the aggregator
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the aggregator
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The ARN of the aggregator
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The ARN of the aggregator
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the aggregator
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing ConfigurationAggregator Resource

    Get an existing ConfigurationAggregator resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ConfigurationAggregatorState, opts?: CustomResourceOptions): ConfigurationAggregator
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_aggregation_source: Optional[ConfigurationAggregatorAccountAggregationSourceArgs] = None,
            arn: Optional[str] = None,
            name: Optional[str] = None,
            organization_aggregation_source: Optional[ConfigurationAggregatorOrganizationAggregationSourceArgs] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> ConfigurationAggregator
    func GetConfigurationAggregator(ctx *Context, name string, id IDInput, state *ConfigurationAggregatorState, opts ...ResourceOption) (*ConfigurationAggregator, error)
    public static ConfigurationAggregator Get(string name, Input<string> id, ConfigurationAggregatorState? state, CustomResourceOptions? opts = null)
    public static ConfigurationAggregator get(String name, Output<String> id, ConfigurationAggregatorState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountAggregationSource ConfigurationAggregatorAccountAggregationSource
    The account(s) to aggregate config data from as documented below.
    Arn string
    The ARN of the aggregator
    Name string
    The name of the configuration aggregator.
    OrganizationAggregationSource ConfigurationAggregatorOrganizationAggregationSource
    The organization to aggregate config data from as documented below.
    Tags Dictionary<string, string>

    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Either account_aggregation_source or organization_aggregation_source must be specified.

    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    AccountAggregationSource ConfigurationAggregatorAccountAggregationSourceArgs
    The account(s) to aggregate config data from as documented below.
    Arn string
    The ARN of the aggregator
    Name string
    The name of the configuration aggregator.
    OrganizationAggregationSource ConfigurationAggregatorOrganizationAggregationSourceArgs
    The organization to aggregate config data from as documented below.
    Tags map[string]string

    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Either account_aggregation_source or organization_aggregation_source must be specified.

    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    accountAggregationSource ConfigurationAggregatorAccountAggregationSource
    The account(s) to aggregate config data from as documented below.
    arn String
    The ARN of the aggregator
    name String
    The name of the configuration aggregator.
    organizationAggregationSource ConfigurationAggregatorOrganizationAggregationSource
    The organization to aggregate config data from as documented below.
    tags Map<String,String>

    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Either account_aggregation_source or organization_aggregation_source must be specified.

    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    accountAggregationSource ConfigurationAggregatorAccountAggregationSource
    The account(s) to aggregate config data from as documented below.
    arn string
    The ARN of the aggregator
    name string
    The name of the configuration aggregator.
    organizationAggregationSource ConfigurationAggregatorOrganizationAggregationSource
    The organization to aggregate config data from as documented below.
    tags {[key: string]: string}

    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Either account_aggregation_source or organization_aggregation_source must be specified.

    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    account_aggregation_source ConfigurationAggregatorAccountAggregationSourceArgs
    The account(s) to aggregate config data from as documented below.
    arn str
    The ARN of the aggregator
    name str
    The name of the configuration aggregator.
    organization_aggregation_source ConfigurationAggregatorOrganizationAggregationSourceArgs
    The organization to aggregate config data from as documented below.
    tags Mapping[str, str]

    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Either account_aggregation_source or organization_aggregation_source must be specified.

    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    accountAggregationSource Property Map
    The account(s) to aggregate config data from as documented below.
    arn String
    The ARN of the aggregator
    name String
    The name of the configuration aggregator.
    organizationAggregationSource Property Map
    The organization to aggregate config data from as documented below.
    tags Map<String>

    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Either account_aggregation_source or organization_aggregation_source must be specified.

    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    ConfigurationAggregatorAccountAggregationSource, ConfigurationAggregatorAccountAggregationSourceArgs

    AccountIds List<string>
    List of 12-digit account IDs of the account(s) being aggregated.
    AllRegions bool
    If true, aggregate existing AWS Config regions and future regions.
    Regions List<string>

    List of source regions being aggregated.

    Either regions or all_regions (as true) must be specified.

    AccountIds []string
    List of 12-digit account IDs of the account(s) being aggregated.
    AllRegions bool
    If true, aggregate existing AWS Config regions and future regions.
    Regions []string

    List of source regions being aggregated.

    Either regions or all_regions (as true) must be specified.

    accountIds List<String>
    List of 12-digit account IDs of the account(s) being aggregated.
    allRegions Boolean
    If true, aggregate existing AWS Config regions and future regions.
    regions List<String>

    List of source regions being aggregated.

    Either regions or all_regions (as true) must be specified.

    accountIds string[]
    List of 12-digit account IDs of the account(s) being aggregated.
    allRegions boolean
    If true, aggregate existing AWS Config regions and future regions.
    regions string[]

    List of source regions being aggregated.

    Either regions or all_regions (as true) must be specified.

    account_ids Sequence[str]
    List of 12-digit account IDs of the account(s) being aggregated.
    all_regions bool
    If true, aggregate existing AWS Config regions and future regions.
    regions Sequence[str]

    List of source regions being aggregated.

    Either regions or all_regions (as true) must be specified.

    accountIds List<String>
    List of 12-digit account IDs of the account(s) being aggregated.
    allRegions Boolean
    If true, aggregate existing AWS Config regions and future regions.
    regions List<String>

    List of source regions being aggregated.

    Either regions or all_regions (as true) must be specified.

    ConfigurationAggregatorOrganizationAggregationSource, ConfigurationAggregatorOrganizationAggregationSourceArgs

    RoleArn string

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

    Either regions or all_regions (as true) must be specified.

    AllRegions bool
    If true, aggregate existing AWS Config regions and future regions.
    Regions List<string>
    List of source regions being aggregated.
    RoleArn string

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

    Either regions or all_regions (as true) must be specified.

    AllRegions bool
    If true, aggregate existing AWS Config regions and future regions.
    Regions []string
    List of source regions being aggregated.
    roleArn String

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

    Either regions or all_regions (as true) must be specified.

    allRegions Boolean
    If true, aggregate existing AWS Config regions and future regions.
    regions List<String>
    List of source regions being aggregated.
    roleArn string

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

    Either regions or all_regions (as true) must be specified.

    allRegions boolean
    If true, aggregate existing AWS Config regions and future regions.
    regions string[]
    List of source regions being aggregated.
    role_arn str

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

    Either regions or all_regions (as true) must be specified.

    all_regions bool
    If true, aggregate existing AWS Config regions and future regions.
    regions Sequence[str]
    List of source regions being aggregated.
    roleArn String

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

    Either regions or all_regions (as true) must be specified.

    allRegions Boolean
    If true, aggregate existing AWS Config regions and future regions.
    regions List<String>
    List of source regions being aggregated.

    Import

    Using pulumi import, import Configuration Aggregators using the name. For example:

    $ pulumi import aws:cfg/configurationAggregator:ConfigurationAggregator example foo
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi