Aggregator

Provides a Cloud Config Aggregator resource.

For information about Cloud Config Aggregate Config Rule and how to use it, see What is Aggregator.

NOTE: Available in v1.124.0+.

Example Usage

Basic Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new AliCloud.Cfg.Aggregator("example", new AliCloud.Cfg.AggregatorArgs
        {
            AggregatorAccounts = 
            {
                new AliCloud.Cfg.Inputs.AggregatorAggregatorAccountArgs
                {
                    AccountId = "123968452689****",
                    AccountName = "tf-testacc1234",
                    AccountType = "ResourceDirectory",
                },
            },
            AggregatorName = "tf-testaccConfigAggregator1234",
            Description = "tf-testaccConfigAggregator1234",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/cfg"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cfg.NewAggregator(ctx, "example", &cfg.AggregatorArgs{
			AggregatorAccounts: cfg.AggregatorAggregatorAccountArray{
				&cfg.AggregatorAggregatorAccountArgs{
					AccountId:   pulumi.String("123968452689****"),
					AccountName: pulumi.String("tf-testacc1234"),
					AccountType: pulumi.String("ResourceDirectory"),
				},
			},
			AggregatorName: pulumi.String("tf-testaccConfigAggregator1234"),
			Description:    pulumi.String("tf-testaccConfigAggregator1234"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.cfg.Aggregator;
import com.pulumi.alicloud.cfg.AggregatorArgs;
import com.pulumi.alicloud.cfg.inputs.AggregatorAggregatorAccountArgs;
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 Aggregator("example", AggregatorArgs.builder()        
            .aggregatorAccounts(AggregatorAggregatorAccountArgs.builder()
                .accountId("123968452689****")
                .accountName("tf-testacc1234")
                .accountType("ResourceDirectory")
                .build())
            .aggregatorName("tf-testaccConfigAggregator1234")
            .description("tf-testaccConfigAggregator1234")
            .build());

    }
}
import pulumi
import pulumi_alicloud as alicloud

example = alicloud.cfg.Aggregator("example",
    aggregator_accounts=[alicloud.cfg.AggregatorAggregatorAccountArgs(
        account_id="123968452689****",
        account_name="tf-testacc1234",
        account_type="ResourceDirectory",
    )],
    aggregator_name="tf-testaccConfigAggregator1234",
    description="tf-testaccConfigAggregator1234")
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const example = new alicloud.cfg.Aggregator("example", {
    aggregatorAccounts: [{
        accountId: "123968452689****",
        accountName: "tf-testacc1234",
        accountType: "ResourceDirectory",
    }],
    aggregatorName: "tf-testaccConfigAggregator1234",
    description: "tf-testaccConfigAggregator1234",
});
resources:
  example:
    type: alicloud:cfg:Aggregator
    properties:
      aggregatorAccounts:
        - accountId: 123968452689****
          accountName: tf-testacc1234
          accountType: ResourceDirectory
      aggregatorName: tf-testaccConfigAggregator1234
      description: tf-testaccConfigAggregator1234

Create Aggregator Resource

new Aggregator(name: string, args: AggregatorArgs, opts?: CustomResourceOptions);
@overload
def Aggregator(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               aggregator_accounts: Optional[Sequence[AggregatorAggregatorAccountArgs]] = None,
               aggregator_name: Optional[str] = None,
               aggregator_type: Optional[str] = None,
               description: Optional[str] = None)
@overload
def Aggregator(resource_name: str,
               args: AggregatorArgs,
               opts: Optional[ResourceOptions] = None)
func NewAggregator(ctx *Context, name string, args AggregatorArgs, opts ...ResourceOption) (*Aggregator, error)
public Aggregator(string name, AggregatorArgs args, CustomResourceOptions? opts = null)
public Aggregator(String name, AggregatorArgs args)
public Aggregator(String name, AggregatorArgs args, CustomResourceOptions options)
type: alicloud:cfg:Aggregator
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args AggregatorArgs
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 AggregatorArgs
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 AggregatorArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AggregatorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AggregatorArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Aggregator 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 Aggregator resource accepts the following input properties:

AggregatorName string

The name of aggregator.

Description string

The description of aggregator.

AggregatorAccounts List<Pulumi.AliCloud.Cfg.Inputs.AggregatorAggregatorAccountArgs>

The information of account in aggregator. If the aggregator_type is RD, it is optional and means add all members in the resource directory to the account group. NOTE: the field aggregator_accounts is not required from version 1.148.0.

AggregatorType string

The type of aggregator. Valid values: CUSTOM, RD. The Default value: CUSTOM.

AggregatorName string

The name of aggregator.

Description string

The description of aggregator.

AggregatorAccounts []AggregatorAggregatorAccountArgs

The information of account in aggregator. If the aggregator_type is RD, it is optional and means add all members in the resource directory to the account group. NOTE: the field aggregator_accounts is not required from version 1.148.0.

AggregatorType string

The type of aggregator. Valid values: CUSTOM, RD. The Default value: CUSTOM.

aggregatorName String

The name of aggregator.

description String

The description of aggregator.

aggregatorAccounts List<AggregatorAggregatorAccountArgs>

The information of account in aggregator. If the aggregator_type is RD, it is optional and means add all members in the resource directory to the account group. NOTE: the field aggregator_accounts is not required from version 1.148.0.

aggregatorType String

The type of aggregator. Valid values: CUSTOM, RD. The Default value: CUSTOM.

aggregatorName string

The name of aggregator.

description string

The description of aggregator.

aggregatorAccounts AggregatorAggregatorAccountArgs[]

The information of account in aggregator. If the aggregator_type is RD, it is optional and means add all members in the resource directory to the account group. NOTE: the field aggregator_accounts is not required from version 1.148.0.

aggregatorType string

The type of aggregator. Valid values: CUSTOM, RD. The Default value: CUSTOM.

aggregator_name str

The name of aggregator.

description str

The description of aggregator.

aggregator_accounts Sequence[AggregatorAggregatorAccountArgs]

The information of account in aggregator. If the aggregator_type is RD, it is optional and means add all members in the resource directory to the account group. NOTE: the field aggregator_accounts is not required from version 1.148.0.

aggregator_type str

The type of aggregator. Valid values: CUSTOM, RD. The Default value: CUSTOM.

aggregatorName String

The name of aggregator.

description String

The description of aggregator.

aggregatorAccounts List<Property Map>

The information of account in aggregator. If the aggregator_type is RD, it is optional and means add all members in the resource directory to the account group. NOTE: the field aggregator_accounts is not required from version 1.148.0.

aggregatorType String

The type of aggregator. Valid values: CUSTOM, RD. The Default value: CUSTOM.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Status string

The status of the resource. Valid values: 0: creating 1: normal 2: deleting.

Id string

The provider-assigned unique ID for this managed resource.

Status string

The status of the resource. Valid values: 0: creating 1: normal 2: deleting.

id String

The provider-assigned unique ID for this managed resource.

status String

The status of the resource. Valid values: 0: creating 1: normal 2: deleting.

id string

The provider-assigned unique ID for this managed resource.

status string

The status of the resource. Valid values: 0: creating 1: normal 2: deleting.

id str

The provider-assigned unique ID for this managed resource.

status str

The status of the resource. Valid values: 0: creating 1: normal 2: deleting.

id String

The provider-assigned unique ID for this managed resource.

status String

The status of the resource. Valid values: 0: creating 1: normal 2: deleting.

Look up Existing Aggregator Resource

Get an existing Aggregator 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?: AggregatorState, opts?: CustomResourceOptions): Aggregator
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aggregator_accounts: Optional[Sequence[AggregatorAggregatorAccountArgs]] = None,
        aggregator_name: Optional[str] = None,
        aggregator_type: Optional[str] = None,
        description: Optional[str] = None,
        status: Optional[str] = None) -> Aggregator
func GetAggregator(ctx *Context, name string, id IDInput, state *AggregatorState, opts ...ResourceOption) (*Aggregator, error)
public static Aggregator Get(string name, Input<string> id, AggregatorState? state, CustomResourceOptions? opts = null)
public static Aggregator get(String name, Output<String> id, AggregatorState 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:
AggregatorAccounts List<Pulumi.AliCloud.Cfg.Inputs.AggregatorAggregatorAccountArgs>

The information of account in aggregator. If the aggregator_type is RD, it is optional and means add all members in the resource directory to the account group. NOTE: the field aggregator_accounts is not required from version 1.148.0.

AggregatorName string

The name of aggregator.

AggregatorType string

The type of aggregator. Valid values: CUSTOM, RD. The Default value: CUSTOM.

Description string

The description of aggregator.

Status string

The status of the resource. Valid values: 0: creating 1: normal 2: deleting.

AggregatorAccounts []AggregatorAggregatorAccountArgs

The information of account in aggregator. If the aggregator_type is RD, it is optional and means add all members in the resource directory to the account group. NOTE: the field aggregator_accounts is not required from version 1.148.0.

AggregatorName string

The name of aggregator.

AggregatorType string

The type of aggregator. Valid values: CUSTOM, RD. The Default value: CUSTOM.

Description string

The description of aggregator.

Status string

The status of the resource. Valid values: 0: creating 1: normal 2: deleting.

aggregatorAccounts List<AggregatorAggregatorAccountArgs>

The information of account in aggregator. If the aggregator_type is RD, it is optional and means add all members in the resource directory to the account group. NOTE: the field aggregator_accounts is not required from version 1.148.0.

aggregatorName String

The name of aggregator.

aggregatorType String

The type of aggregator. Valid values: CUSTOM, RD. The Default value: CUSTOM.

description String

The description of aggregator.

status String

The status of the resource. Valid values: 0: creating 1: normal 2: deleting.

aggregatorAccounts AggregatorAggregatorAccountArgs[]

The information of account in aggregator. If the aggregator_type is RD, it is optional and means add all members in the resource directory to the account group. NOTE: the field aggregator_accounts is not required from version 1.148.0.

aggregatorName string

The name of aggregator.

aggregatorType string

The type of aggregator. Valid values: CUSTOM, RD. The Default value: CUSTOM.

description string

The description of aggregator.

status string

The status of the resource. Valid values: 0: creating 1: normal 2: deleting.

aggregator_accounts Sequence[AggregatorAggregatorAccountArgs]

The information of account in aggregator. If the aggregator_type is RD, it is optional and means add all members in the resource directory to the account group. NOTE: the field aggregator_accounts is not required from version 1.148.0.

aggregator_name str

The name of aggregator.

aggregator_type str

The type of aggregator. Valid values: CUSTOM, RD. The Default value: CUSTOM.

description str

The description of aggregator.

status str

The status of the resource. Valid values: 0: creating 1: normal 2: deleting.

aggregatorAccounts List<Property Map>

The information of account in aggregator. If the aggregator_type is RD, it is optional and means add all members in the resource directory to the account group. NOTE: the field aggregator_accounts is not required from version 1.148.0.

aggregatorName String

The name of aggregator.

aggregatorType String

The type of aggregator. Valid values: CUSTOM, RD. The Default value: CUSTOM.

description String

The description of aggregator.

status String

The status of the resource. Valid values: 0: creating 1: normal 2: deleting.

Supporting Types

AggregatorAggregatorAccount

AccountId string

Aggregator account Uid.

AccountName string

Aggregator account name.

AccountType string

Aggregator account source type. Valid values: ResourceDirectory.

AccountId string

Aggregator account Uid.

AccountName string

Aggregator account name.

AccountType string

Aggregator account source type. Valid values: ResourceDirectory.

accountId String

Aggregator account Uid.

accountName String

Aggregator account name.

accountType String

Aggregator account source type. Valid values: ResourceDirectory.

accountId string

Aggregator account Uid.

accountName string

Aggregator account name.

accountType string

Aggregator account source type. Valid values: ResourceDirectory.

account_id str

Aggregator account Uid.

account_name str

Aggregator account name.

account_type str

Aggregator account source type. Valid values: ResourceDirectory.

accountId String

Aggregator account Uid.

accountName String

Aggregator account name.

accountType String

Aggregator account source type. Valid values: ResourceDirectory.

Import

Cloud Config Aggregator can be imported using the id, e.g.

 $ pulumi import alicloud:cfg/aggregator:Aggregator example <id>

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.