Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. cfg
  5. AggregateAuthorization
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.cfg.AggregateAuthorization

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

Manages an AWS Config Aggregate Authorization

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.cfg.AggregateAuthorization("example", {
    accountId: "123456789012",
    region: "eu-west-2",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.cfg.AggregateAuthorization("example",
    account_id="123456789012",
    region="eu-west-2")
Copy
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.NewAggregateAuthorization(ctx, "example", &cfg.AggregateAuthorizationArgs{
			AccountId: pulumi.String("123456789012"),
			Region:    pulumi.String("eu-west-2"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Cfg.AggregateAuthorization("example", new()
    {
        AccountId = "123456789012",
        Region = "eu-west-2",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cfg.AggregateAuthorization;
import com.pulumi.aws.cfg.AggregateAuthorizationArgs;
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 example = new AggregateAuthorization("example", AggregateAuthorizationArgs.builder()
            .accountId("123456789012")
            .region("eu-west-2")
            .build());

    }
}
Copy
resources:
  example:
    type: aws:cfg:AggregateAuthorization
    properties:
      accountId: '123456789012'
      region: eu-west-2
Copy

Create AggregateAuthorization Resource

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

Constructor syntax

new AggregateAuthorization(name: string, args: AggregateAuthorizationArgs, opts?: CustomResourceOptions);
@overload
def AggregateAuthorization(resource_name: str,
                           args: AggregateAuthorizationArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def AggregateAuthorization(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           account_id: Optional[str] = None,
                           region: Optional[str] = None,
                           tags: Optional[Mapping[str, str]] = None)
func NewAggregateAuthorization(ctx *Context, name string, args AggregateAuthorizationArgs, opts ...ResourceOption) (*AggregateAuthorization, error)
public AggregateAuthorization(string name, AggregateAuthorizationArgs args, CustomResourceOptions? opts = null)
public AggregateAuthorization(String name, AggregateAuthorizationArgs args)
public AggregateAuthorization(String name, AggregateAuthorizationArgs args, CustomResourceOptions options)

type: aws:cfg:AggregateAuthorization
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

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

var aggregateAuthorizationResource = new Aws.Cfg.AggregateAuthorization("aggregateAuthorizationResource", new()
{
    AccountId = "string",
    Region = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := cfg.NewAggregateAuthorization(ctx, "aggregateAuthorizationResource", &cfg.AggregateAuthorizationArgs{
	AccountId: pulumi.String("string"),
	Region:    pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var aggregateAuthorizationResource = new AggregateAuthorization("aggregateAuthorizationResource", AggregateAuthorizationArgs.builder()
    .accountId("string")
    .region("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
aggregate_authorization_resource = aws.cfg.AggregateAuthorization("aggregateAuthorizationResource",
    account_id="string",
    region="string",
    tags={
        "string": "string",
    })
Copy
const aggregateAuthorizationResource = new aws.cfg.AggregateAuthorization("aggregateAuthorizationResource", {
    accountId: "string",
    region: "string",
    tags: {
        string: "string",
    },
});
Copy
type: aws:cfg:AggregateAuthorization
properties:
    accountId: string
    region: string
    tags:
        string: string
Copy

AggregateAuthorization Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AggregateAuthorization resource accepts the following input properties:

AccountId
This property is required.
Changes to this property will trigger replacement.
string
Account ID
Region
This property is required.
Changes to this property will trigger replacement.
string
Region
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.
AccountId
This property is required.
Changes to this property will trigger replacement.
string
Account ID
Region
This property is required.
Changes to this property will trigger replacement.
string
Region
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.
accountId
This property is required.
Changes to this property will trigger replacement.
String
Account ID
region
This property is required.
Changes to this property will trigger replacement.
String
Region
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.
accountId
This property is required.
Changes to this property will trigger replacement.
string
Account ID
region
This property is required.
Changes to this property will trigger replacement.
string
Region
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.
account_id
This property is required.
Changes to this property will trigger replacement.
str
Account ID
region
This property is required.
Changes to this property will trigger replacement.
str
Region
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.
accountId
This property is required.
Changes to this property will trigger replacement.
String
Account ID
region
This property is required.
Changes to this property will trigger replacement.
String
Region
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.

Outputs

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

Arn string
The ARN of the authorization
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 authorization
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 authorization
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 authorization
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 authorization
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 authorization
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 AggregateAuthorization Resource

Get an existing AggregateAuthorization 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?: AggregateAuthorizationState, opts?: CustomResourceOptions): AggregateAuthorization
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        arn: Optional[str] = None,
        region: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> AggregateAuthorization
func GetAggregateAuthorization(ctx *Context, name string, id IDInput, state *AggregateAuthorizationState, opts ...ResourceOption) (*AggregateAuthorization, error)
public static AggregateAuthorization Get(string name, Input<string> id, AggregateAuthorizationState? state, CustomResourceOptions? opts = null)
public static AggregateAuthorization get(String name, Output<String> id, AggregateAuthorizationState state, CustomResourceOptions options)
resources:  _:    type: aws:cfg:AggregateAuthorization    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AccountId Changes to this property will trigger replacement. string
Account ID
Arn string
The ARN of the authorization
Region Changes to this property will trigger replacement. string
Region
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.
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.

AccountId Changes to this property will trigger replacement. string
Account ID
Arn string
The ARN of the authorization
Region Changes to this property will trigger replacement. string
Region
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.
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.

accountId Changes to this property will trigger replacement. String
Account ID
arn String
The ARN of the authorization
region Changes to this property will trigger replacement. String
Region
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.
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.

accountId Changes to this property will trigger replacement. string
Account ID
arn string
The ARN of the authorization
region Changes to this property will trigger replacement. string
Region
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.
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_id Changes to this property will trigger replacement. str
Account ID
arn str
The ARN of the authorization
region Changes to this property will trigger replacement. str
Region
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.
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.

accountId Changes to this property will trigger replacement. String
Account ID
arn String
The ARN of the authorization
region Changes to this property will trigger replacement. String
Region
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.
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.

Import

Using pulumi import, import Config aggregate authorizations using account_id:region. For example:

$ pulumi import aws:cfg/aggregateAuthorization:AggregateAuthorization example 123456789012:us-east-1
Copy

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 v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws