pulumi-alicloud-kotlin/com.pulumi.alicloud.cfg.kotlin/AggregateConfigRule

AggregateConfigRule

class AggregateConfigRule : KotlinCustomResource

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

NOTE: Available since v1.124.0.

Example Usage

Basic Usage

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 com.pulumi.alicloud.cfg.AggregateConfigRule;
import com.pulumi.alicloud.cfg.AggregateConfigRuleArgs;
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 defaultAccounts = ResourcemanagerFunctions.getAccounts(GetAccountsArgs.builder()
            .status("CreateSuccess")
            .build());
        var defaultAggregator = new Aggregator("defaultAggregator", AggregatorArgs.builder()
            .aggregatorAccounts(AggregatorAggregatorAccountArgs.builder()
                .accountId(defaultAccounts.applyValue(getAccountsResult -> getAccountsResult.accounts()[0].accountId()))
                .accountName(defaultAccounts.applyValue(getAccountsResult -> getAccountsResult.accounts()[0].displayName()))
                .accountType("ResourceDirectory")
                .build())
            .aggregatorName(name)
            .description(name)
            .aggregatorType("CUSTOM")
            .build());
        var defaultAggregateConfigRule = new AggregateConfigRule("defaultAggregateConfigRule", AggregateConfigRuleArgs.builder()
            .aggregateConfigRuleName("contains-tag")
            .aggregatorId(defaultAggregator.id())
            .configRuleTriggerTypes("ConfigurationItemChangeNotification")
            .sourceOwner("ALIYUN")
            .sourceIdentifier("contains-tag")
            .riskLevel(1)
            .resourceTypesScopes("ACS::ECS::Instance")
            .inputParameters(Map.ofEntries(
                Map.entry("key", "example"),
                Map.entry("value", "example")
            ))
            .build());
    }
}

Import

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

$ pulumi import alicloud:cfg/aggregateConfigRule:AggregateConfigRule example "<aggregator_id>:<config_rule_id>"

Properties

aggregateConfigRuleName

val aggregateConfigRuleName: Output<String>

The name of the rule.

aggregatorId

val aggregatorId: Output<String>

The Aggregator Id.

configRuleId

val configRuleId: Output<String>

(Available since v1.141.0) The rule ID of Aggregate Config Rule.

configRuleTriggerTypes

val configRuleTriggerTypes: Output<String>

The trigger type of the rule. Valid values: ConfigurationItemChangeNotification: The rule is triggered upon configuration changes. ScheduledNotification: The rule is triggered as scheduled.

description

val description: Output<String>?

The description of the rule.

excludeResourceIdsScope

val excludeResourceIdsScope: Output<String>?

The rule monitors excluded resource IDs, multiple of which are separated by commas, only applies to rules created based on managed rules, , custom rule this field is empty.

val id: Output<String>

inputParameters

val inputParameters: Output<Map<String, Any>>?

The settings map of the input parameters for the rule.

maximumExecutionFrequency

val maximumExecutionFrequency: Output<String>

The frequency of the compliance evaluations. Valid values: One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours. System default value is TwentyFour_Hours and valid when the config_rule_trigger_types is ScheduledNotification.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

regionIdsScope

val regionIdsScope: Output<String>?

The rule monitors region IDs, separated by commas, only applies to rules created based on managed rules.

resourceGroupIdsScope

val resourceGroupIdsScope: Output<String>?

The rule monitors resource group IDs, separated by commas, only applies to rules created based on managed rules.

resourceTypesScopes

val resourceTypesScopes: Output<List<String>>

Resource types to be evaluated. Alibaba Cloud services that support Cloud Config.

riskLevel

val riskLevel: Output<Int>

The risk level of the resources that are not compliant with the rule. Valid values: 1: critical 2: warning 3: info.

sourceIdentifier

val sourceIdentifier: Output<String>

The identifier of the rule. For a managed rule, the value is the identifier of the managed rule. For a custom rule, the value is the ARN of the custom rule. Using managed rules, refer to List of Managed rules.

sourceOwner

val sourceOwner: Output<String>

Specifies whether you or Alibaba Cloud owns and manages the rule. Valid values: CUSTOM_FC: The rule is a custom rule and you own the rule. ALIYUN: The rule is a managed rule and Alibaba Cloud owns the rule.

status

val status: Output<String>

The rule status. The valid values: ACTIVE, INACTIVE.

tagKeyScope

val tagKeyScope: Output<String>?

The rule monitors the tag key, only applies to rules created based on managed rules.

tagValueScope

val tagValueScope: Output<String>?

The rule monitors the tag value, use with the tag_key_scope options. only applies to rules created based on managed rules.

urn

val urn: Output<String>