Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alicloud Provider
  3. API Docs
  4. cfg
  5. Aggregator
Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.cfg.Aggregator

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi
pulumi/pulumi-alicloud

    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 since v1.124.0.

    Example Usage

    Basic Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "tf_example";
const default = alicloud.resourcemanager.getAccounts({
    status: "CreateSuccess",
});
const defaultAggregator = new alicloud.cfg.Aggregator("default", {
    aggregatorAccounts: [{
        accountId: _default.then(_default => _default.accounts?.[0]?.accountId),
        accountName: _default.then(_default => _default.accounts?.[0]?.displayName),
        accountType: "ResourceDirectory",
    }],
    aggregatorName: name,
    description: name,
    aggregatorType: "CUSTOM",
});

    import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "tf_example"
default = alicloud.resourcemanager.get_accounts(status="CreateSuccess")
default_aggregator = alicloud.cfg.Aggregator("default",
    aggregator_accounts=[{
        "account_id": default.accounts[0].account_id,
        "account_name": default.accounts[0].display_name,
        "account_type": "ResourceDirectory",
    }],
    aggregator_name=name,
    description=name,
    aggregator_type="CUSTOM")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "tf_example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_default, err := resourcemanager.GetAccounts(ctx, &resourcemanager.GetAccountsArgs{
			Status: pulumi.StringRef("CreateSuccess"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = cfg.NewAggregator(ctx, "default", &cfg.AggregatorArgs{
			AggregatorAccounts: cfg.AggregatorAggregatorAccountArray{
				&cfg.AggregatorAggregatorAccountArgs{
					AccountId:   pulumi.String(_default.Accounts[0].AccountId),
					AccountName: pulumi.String(_default.Accounts[0].DisplayName),
					AccountType: pulumi.String("ResourceDirectory"),
				},
			},
			AggregatorName: pulumi.String(name),
			Description:    pulumi.String(name),
			AggregatorType: pulumi.String("CUSTOM"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "tf_example";
    var @default = AliCloud.ResourceManager.GetAccounts.Invoke(new()
    {
        Status = "CreateSuccess",
    });

    var defaultAggregator = new AliCloud.Cfg.Aggregator("default", new()
    {
        AggregatorAccounts = new[]
        {
            new AliCloud.Cfg.Inputs.AggregatorAggregatorAccountArgs
            {
                AccountId = @default.Apply(@default => @default.Apply(getAccountsResult => getAccountsResult.Accounts[0]?.AccountId)),
                AccountName = @default.Apply(@default => @default.Apply(getAccountsResult => getAccountsResult.Accounts[0]?.DisplayName)),
                AccountType = "ResourceDirectory",
            },
        },
        AggregatorName = name,
        Description = name,
        AggregatorType = "CUSTOM",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.resourcemanager.ResourcemanagerFunctions;
import com.pulumi.alicloud.resourcemanager.inputs.GetAccountsArgs;
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) {
        final var config = ctx.config();
        final var name = config.get("name").orElse("tf_example");
        final var default = ResourcemanagerFunctions.getAccounts(GetAccountsArgs.builder()
            .status("CreateSuccess")
            .build());

        var defaultAggregator = new Aggregator("defaultAggregator", AggregatorArgs.builder()
            .aggregatorAccounts(AggregatorAggregatorAccountArgs.builder()
                .accountId(default_.accounts()[0].accountId())
                .accountName(default_.accounts()[0].displayName())
                .accountType("ResourceDirectory")
                .build())
            .aggregatorName(name)
            .description(name)
            .aggregatorType("CUSTOM")
            .build());

    }
}

    configuration:
  name:
    type: string
    default: tf_example
resources:
  defaultAggregator:
    type: alicloud:cfg:Aggregator
    name: default
    properties:
      aggregatorAccounts:
        - accountId: ${default.accounts[0].accountId}
          accountName: ${default.accounts[0].displayName}
          accountType: ResourceDirectory
      aggregatorName: ${name}
      description: ${name}
      aggregatorType: CUSTOM
variables:
  default:
    fn::invoke:
      Function: alicloud:resourcemanager:getAccounts
      Arguments:
        status: CreateSuccess

    Create Aggregator Resource

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

    Constructor syntax

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

@overload
def Aggregator(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               aggregator_name: Optional[str] = None,
               description: Optional[str] = None,
               aggregator_accounts: Optional[Sequence[AggregatorAggregatorAccountArgs]] = None,
               aggregator_type: Optional[str] = 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.

    Parameters

    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.

    Constructor example

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

    var aggregatorResource = new AliCloud.Cfg.Aggregator("aggregatorResource", new()
{
    AggregatorName = "string",
    Description = "string",
    AggregatorAccounts = new[]
    {
        new AliCloud.Cfg.Inputs.AggregatorAggregatorAccountArgs
        {
            AccountId = "string",
            AccountName = "string",
            AccountType = "string",
        },
    },
    AggregatorType = "string",
});

    example, err := cfg.NewAggregator(ctx, "aggregatorResource", &cfg.AggregatorArgs{
	AggregatorName: pulumi.String("string"),
	Description:    pulumi.String("string"),
	AggregatorAccounts: cfg.AggregatorAggregatorAccountArray{
		&cfg.AggregatorAggregatorAccountArgs{
			AccountId:   pulumi.String("string"),
			AccountName: pulumi.String("string"),
			AccountType: pulumi.String("string"),
		},
	},
	AggregatorType: pulumi.String("string"),
})

    var aggregatorResource = new Aggregator("aggregatorResource", AggregatorArgs.builder()
    .aggregatorName("string")
    .description("string")
    .aggregatorAccounts(AggregatorAggregatorAccountArgs.builder()
        .accountId("string")
        .accountName("string")
        .accountType("string")
        .build())
    .aggregatorType("string")
    .build());

    aggregator_resource = alicloud.cfg.Aggregator("aggregatorResource",
    aggregator_name="string",
    description="string",
    aggregator_accounts=[alicloud.cfg.AggregatorAggregatorAccountArgs(
        account_id="string",
        account_name="string",
        account_type="string",
    )],
    aggregator_type="string")

    const aggregatorResource = new alicloud.cfg.Aggregator("aggregatorResource", {
    aggregatorName: "string",
    description: "string",
    aggregatorAccounts: [{
        accountId: "string",
        accountName: "string",
        accountType: "string",
    }],
    aggregatorType: "string",
});

    type: alicloud:cfg:Aggregator
properties:
    aggregatorAccounts:
        - accountId: string
          accountName: string
          accountType: string
    aggregatorName: string
    aggregatorType: string
    description: string

    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.AggregatorAggregatorAccount>
    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. See aggregator_accounts below. 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.

    • CUSTOM - The custom account group.
    • RD - The global account group.
    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. See aggregator_accounts below. 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.

    • CUSTOM - The custom account group.
    • RD - The global account group.
    aggregatorName String
    The name of aggregator.
    description String
    The description of aggregator.
    aggregatorAccounts List<AggregatorAggregatorAccount>
    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. See aggregator_accounts below. 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.

    • CUSTOM - The custom account group.
    • RD - The global account group.
    aggregatorName string
    The name of aggregator.
    description string
    The description of aggregator.
    aggregatorAccounts AggregatorAggregatorAccount[]
    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. See aggregator_accounts below. 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.

    • CUSTOM - The custom account group.
    • RD - The global account group.
    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. See aggregator_accounts below. 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.

    • CUSTOM - The custom account group.
    • RD - The global account group.
    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. See aggregator_accounts below. 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.

    • CUSTOM - The custom account group.
    • RD - The global account group.

    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.AggregatorAggregatorAccount>
    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. See aggregator_accounts below. 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.

    • CUSTOM - The custom account group.
    • RD - The global account group.
    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. See aggregator_accounts below. 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.

    • CUSTOM - The custom account group.
    • RD - The global account group.
    Description string
    The description of aggregator.
    Status string
    The status of the resource. Valid values: 0: creating 1: normal 2: deleting.
    aggregatorAccounts List<AggregatorAggregatorAccount>
    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. See aggregator_accounts below. 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.

    • CUSTOM - The custom account group.
    • RD - The global account group.
    description String
    The description of aggregator.
    status String
    The status of the resource. Valid values: 0: creating 1: normal 2: deleting.
    aggregatorAccounts AggregatorAggregatorAccount[]
    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. See aggregator_accounts below. 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.

    • CUSTOM - The custom account group.
    • RD - The global account group.
    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. See aggregator_accounts below. 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.

    • CUSTOM - The custom account group.
    • RD - The global account group.
    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. See aggregator_accounts below. 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.

    • CUSTOM - The custom account group.
    • RD - The global account group.
    description String
    The description of aggregator.
    status String
    The status of the resource. Valid values: 0: creating 1: normal 2: deleting.

    Supporting Types

    AggregatorAggregatorAccount, AggregatorAggregatorAccountArgs

    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>

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

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi
    pulumi/pulumi-alicloud