1. Packages
  2. Ibm Provider
  3. API Docs
  4. ConfigAggregatorSettings
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.ConfigAggregatorSettings

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Create, update, and delete config_aggregator_settingss with this resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const configAggregatorSettingsInstance = new ibm.ConfigAggregatorSettings("configAggregatorSettingsInstance", {
        instanceId: _var.instance_id,
        region: _var.region,
        additionalScopes: [{
            type: "Enterprise",
            enterpriseId: "enterprise_id",
            profileTemplate: {
                id: "ProfileTemplate-adb55769-ae22-4c60-aead-bd1f84f93c57",
                trustedProfileId: "Profile-6bb60124-8fc3-4d18-b63d-0b99560865d3",
            },
        }],
        resourceCollectionRegions: us_south,
        resourceCollectionEnabled: true,
        trustedProfileId: "Profile-1260aec2-f2fc-44e2-8697-2cc15a447560",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    config_aggregator_settings_instance = ibm.ConfigAggregatorSettings("configAggregatorSettingsInstance",
        instance_id=var["instance_id"],
        region=var["region"],
        additional_scopes=[{
            "type": "Enterprise",
            "enterprise_id": "enterprise_id",
            "profile_template": {
                "id": "ProfileTemplate-adb55769-ae22-4c60-aead-bd1f84f93c57",
                "trusted_profile_id": "Profile-6bb60124-8fc3-4d18-b63d-0b99560865d3",
            },
        }],
        resource_collection_regions=us_south,
        resource_collection_enabled=True,
        trusted_profile_id="Profile-1260aec2-f2fc-44e2-8697-2cc15a447560")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.NewConfigAggregatorSettings(ctx, "configAggregatorSettingsInstance", &ibm.ConfigAggregatorSettingsArgs{
    			InstanceId: pulumi.Any(_var.Instance_id),
    			Region:     pulumi.Any(_var.Region),
    			AdditionalScopes: ibm.ConfigAggregatorSettingsAdditionalScopeArray{
    				&ibm.ConfigAggregatorSettingsAdditionalScopeArgs{
    					Type:         pulumi.String("Enterprise"),
    					EnterpriseId: pulumi.String("enterprise_id"),
    					ProfileTemplate: &ibm.ConfigAggregatorSettingsAdditionalScopeProfileTemplateArgs{
    						Id:               pulumi.String("ProfileTemplate-adb55769-ae22-4c60-aead-bd1f84f93c57"),
    						TrustedProfileId: pulumi.String("Profile-6bb60124-8fc3-4d18-b63d-0b99560865d3"),
    					},
    				},
    			},
    			ResourceCollectionRegions: pulumi.Any(us_south),
    			ResourceCollectionEnabled: pulumi.Bool(true),
    			TrustedProfileId:          pulumi.String("Profile-1260aec2-f2fc-44e2-8697-2cc15a447560"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var configAggregatorSettingsInstance = new Ibm.ConfigAggregatorSettings("configAggregatorSettingsInstance", new()
        {
            InstanceId = @var.Instance_id,
            Region = @var.Region,
            AdditionalScopes = new[]
            {
                new Ibm.Inputs.ConfigAggregatorSettingsAdditionalScopeArgs
                {
                    Type = "Enterprise",
                    EnterpriseId = "enterprise_id",
                    ProfileTemplate = new Ibm.Inputs.ConfigAggregatorSettingsAdditionalScopeProfileTemplateArgs
                    {
                        Id = "ProfileTemplate-adb55769-ae22-4c60-aead-bd1f84f93c57",
                        TrustedProfileId = "Profile-6bb60124-8fc3-4d18-b63d-0b99560865d3",
                    },
                },
            },
            ResourceCollectionRegions = us_south,
            ResourceCollectionEnabled = true,
            TrustedProfileId = "Profile-1260aec2-f2fc-44e2-8697-2cc15a447560",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.ConfigAggregatorSettings;
    import com.pulumi.ibm.ConfigAggregatorSettingsArgs;
    import com.pulumi.ibm.inputs.ConfigAggregatorSettingsAdditionalScopeArgs;
    import com.pulumi.ibm.inputs.ConfigAggregatorSettingsAdditionalScopeProfileTemplateArgs;
    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 configAggregatorSettingsInstance = new ConfigAggregatorSettings("configAggregatorSettingsInstance", ConfigAggregatorSettingsArgs.builder()
                .instanceId(var_.instance_id())
                .region(var_.region())
                .additionalScopes(ConfigAggregatorSettingsAdditionalScopeArgs.builder()
                    .type("Enterprise")
                    .enterpriseId("enterprise_id")
                    .profileTemplate(ConfigAggregatorSettingsAdditionalScopeProfileTemplateArgs.builder()
                        .id("ProfileTemplate-adb55769-ae22-4c60-aead-bd1f84f93c57")
                        .trustedProfileId("Profile-6bb60124-8fc3-4d18-b63d-0b99560865d3")
                        .build())
                    .build())
                .resourceCollectionRegions(us_south)
                .resourceCollectionEnabled(true)
                .trustedProfileId("Profile-1260aec2-f2fc-44e2-8697-2cc15a447560")
                .build());
    
        }
    }
    
    resources:
      configAggregatorSettingsInstance:
        type: ibm:ConfigAggregatorSettings
        properties:
          instanceId: ${var.instance_id}
          region: ${var.region}
          additionalScopes:
            - type: Enterprise
              enterpriseId: enterprise_id
              profileTemplate:
                id: ProfileTemplate-adb55769-ae22-4c60-aead-bd1f84f93c57
                trustedProfileId: Profile-6bb60124-8fc3-4d18-b63d-0b99560865d3
          resourceCollectionRegions: ${["us-south"]}
          resourceCollectionEnabled: true
          trustedProfileId: Profile-1260aec2-f2fc-44e2-8697-2cc15a447560
    

    Create ConfigAggregatorSettings Resource

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

    Constructor syntax

    new ConfigAggregatorSettings(name: string, args: ConfigAggregatorSettingsArgs, opts?: CustomResourceOptions);
    @overload
    def ConfigAggregatorSettings(resource_name: str,
                                 args: ConfigAggregatorSettingsArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def ConfigAggregatorSettings(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 instance_id: Optional[str] = None,
                                 resource_collection_enabled: Optional[bool] = None,
                                 resource_collection_regions: Optional[Sequence[str]] = None,
                                 trusted_profile_id: Optional[str] = None,
                                 additional_scopes: Optional[Sequence[ConfigAggregatorSettingsAdditionalScopeArgs]] = None,
                                 config_aggregator_settings_id: Optional[str] = None,
                                 region: Optional[str] = None)
    func NewConfigAggregatorSettings(ctx *Context, name string, args ConfigAggregatorSettingsArgs, opts ...ResourceOption) (*ConfigAggregatorSettings, error)
    public ConfigAggregatorSettings(string name, ConfigAggregatorSettingsArgs args, CustomResourceOptions? opts = null)
    public ConfigAggregatorSettings(String name, ConfigAggregatorSettingsArgs args)
    public ConfigAggregatorSettings(String name, ConfigAggregatorSettingsArgs args, CustomResourceOptions options)
    
    type: ibm:ConfigAggregatorSettings
    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 ConfigAggregatorSettingsArgs
    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 ConfigAggregatorSettingsArgs
    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 ConfigAggregatorSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConfigAggregatorSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConfigAggregatorSettingsArgs
    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 configAggregatorSettingsResource = new Ibm.ConfigAggregatorSettings("configAggregatorSettingsResource", new()
    {
        InstanceId = "string",
        ResourceCollectionEnabled = false,
        ResourceCollectionRegions = new[]
        {
            "string",
        },
        TrustedProfileId = "string",
        AdditionalScopes = new[]
        {
            new Ibm.Inputs.ConfigAggregatorSettingsAdditionalScopeArgs
            {
                EnterpriseId = "string",
                ProfileTemplate = new Ibm.Inputs.ConfigAggregatorSettingsAdditionalScopeProfileTemplateArgs
                {
                    Id = "string",
                    TrustedProfileId = "string",
                },
                Type = "string",
            },
        },
        ConfigAggregatorSettingsId = "string",
        Region = "string",
    });
    
    example, err := ibm.NewConfigAggregatorSettings(ctx, "configAggregatorSettingsResource", &ibm.ConfigAggregatorSettingsArgs{
    	InstanceId:                pulumi.String("string"),
    	ResourceCollectionEnabled: pulumi.Bool(false),
    	ResourceCollectionRegions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	TrustedProfileId: pulumi.String("string"),
    	AdditionalScopes: ibm.ConfigAggregatorSettingsAdditionalScopeArray{
    		&ibm.ConfigAggregatorSettingsAdditionalScopeArgs{
    			EnterpriseId: pulumi.String("string"),
    			ProfileTemplate: &ibm.ConfigAggregatorSettingsAdditionalScopeProfileTemplateArgs{
    				Id:               pulumi.String("string"),
    				TrustedProfileId: pulumi.String("string"),
    			},
    			Type: pulumi.String("string"),
    		},
    	},
    	ConfigAggregatorSettingsId: pulumi.String("string"),
    	Region:                     pulumi.String("string"),
    })
    
    var configAggregatorSettingsResource = new ConfigAggregatorSettings("configAggregatorSettingsResource", ConfigAggregatorSettingsArgs.builder()
        .instanceId("string")
        .resourceCollectionEnabled(false)
        .resourceCollectionRegions("string")
        .trustedProfileId("string")
        .additionalScopes(ConfigAggregatorSettingsAdditionalScopeArgs.builder()
            .enterpriseId("string")
            .profileTemplate(ConfigAggregatorSettingsAdditionalScopeProfileTemplateArgs.builder()
                .id("string")
                .trustedProfileId("string")
                .build())
            .type("string")
            .build())
        .configAggregatorSettingsId("string")
        .region("string")
        .build());
    
    config_aggregator_settings_resource = ibm.ConfigAggregatorSettings("configAggregatorSettingsResource",
        instance_id="string",
        resource_collection_enabled=False,
        resource_collection_regions=["string"],
        trusted_profile_id="string",
        additional_scopes=[{
            "enterprise_id": "string",
            "profile_template": {
                "id": "string",
                "trusted_profile_id": "string",
            },
            "type": "string",
        }],
        config_aggregator_settings_id="string",
        region="string")
    
    const configAggregatorSettingsResource = new ibm.ConfigAggregatorSettings("configAggregatorSettingsResource", {
        instanceId: "string",
        resourceCollectionEnabled: false,
        resourceCollectionRegions: ["string"],
        trustedProfileId: "string",
        additionalScopes: [{
            enterpriseId: "string",
            profileTemplate: {
                id: "string",
                trustedProfileId: "string",
            },
            type: "string",
        }],
        configAggregatorSettingsId: "string",
        region: "string",
    });
    
    type: ibm:ConfigAggregatorSettings
    properties:
        additionalScopes:
            - enterpriseId: string
              profileTemplate:
                id: string
                trustedProfileId: string
              type: string
        configAggregatorSettingsId: string
        instanceId: string
        region: string
        resourceCollectionEnabled: false
        resourceCollectionRegions:
            - string
        trustedProfileId: string
    

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

    InstanceId string
    The GUID of the Configuration Aggregator instance.
    ResourceCollectionEnabled bool
    The field denoting if the resource collection is enabled.
    ResourceCollectionRegions List<string>
    The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    TrustedProfileId string
    The trusted profile id that provides Reader access to the App Configuration instance to collect resource metadata.

    • Constraints: The maximum length is 44 characters. The minimum length is 44 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.
    AdditionalScopes List<ConfigAggregatorSettingsAdditionalScope>
    The additional scope that enables resource collection for Enterprise acccounts.

    • Constraints: The maximum length is 10 items. The minimum length is 0 items. Nested schema for additional_scope:
    ConfigAggregatorSettingsId string
    The unique identifier of the config_aggregator_settings.
    Region string
    The region of the configuration aggregator instance.
    InstanceId string
    The GUID of the Configuration Aggregator instance.
    ResourceCollectionEnabled bool
    The field denoting if the resource collection is enabled.
    ResourceCollectionRegions []string
    The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    TrustedProfileId string
    The trusted profile id that provides Reader access to the App Configuration instance to collect resource metadata.

    • Constraints: The maximum length is 44 characters. The minimum length is 44 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.
    AdditionalScopes []ConfigAggregatorSettingsAdditionalScopeArgs
    The additional scope that enables resource collection for Enterprise acccounts.

    • Constraints: The maximum length is 10 items. The minimum length is 0 items. Nested schema for additional_scope:
    ConfigAggregatorSettingsId string
    The unique identifier of the config_aggregator_settings.
    Region string
    The region of the configuration aggregator instance.
    instanceId String
    The GUID of the Configuration Aggregator instance.
    resourceCollectionEnabled Boolean
    The field denoting if the resource collection is enabled.
    resourceCollectionRegions List<String>
    The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    trustedProfileId String
    The trusted profile id that provides Reader access to the App Configuration instance to collect resource metadata.

    • Constraints: The maximum length is 44 characters. The minimum length is 44 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.
    additionalScopes List<ConfigAggregatorSettingsAdditionalScope>
    The additional scope that enables resource collection for Enterprise acccounts.

    • Constraints: The maximum length is 10 items. The minimum length is 0 items. Nested schema for additional_scope:
    configAggregatorSettingsId String
    The unique identifier of the config_aggregator_settings.
    region String
    The region of the configuration aggregator instance.
    instanceId string
    The GUID of the Configuration Aggregator instance.
    resourceCollectionEnabled boolean
    The field denoting if the resource collection is enabled.
    resourceCollectionRegions string[]
    The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    trustedProfileId string
    The trusted profile id that provides Reader access to the App Configuration instance to collect resource metadata.

    • Constraints: The maximum length is 44 characters. The minimum length is 44 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.
    additionalScopes ConfigAggregatorSettingsAdditionalScope[]
    The additional scope that enables resource collection for Enterprise acccounts.

    • Constraints: The maximum length is 10 items. The minimum length is 0 items. Nested schema for additional_scope:
    configAggregatorSettingsId string
    The unique identifier of the config_aggregator_settings.
    region string
    The region of the configuration aggregator instance.
    instance_id str
    The GUID of the Configuration Aggregator instance.
    resource_collection_enabled bool
    The field denoting if the resource collection is enabled.
    resource_collection_regions Sequence[str]
    The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    trusted_profile_id str
    The trusted profile id that provides Reader access to the App Configuration instance to collect resource metadata.

    • Constraints: The maximum length is 44 characters. The minimum length is 44 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.
    additional_scopes Sequence[ConfigAggregatorSettingsAdditionalScopeArgs]
    The additional scope that enables resource collection for Enterprise acccounts.

    • Constraints: The maximum length is 10 items. The minimum length is 0 items. Nested schema for additional_scope:
    config_aggregator_settings_id str
    The unique identifier of the config_aggregator_settings.
    region str
    The region of the configuration aggregator instance.
    instanceId String
    The GUID of the Configuration Aggregator instance.
    resourceCollectionEnabled Boolean
    The field denoting if the resource collection is enabled.
    resourceCollectionRegions List<String>
    The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    trustedProfileId String
    The trusted profile id that provides Reader access to the App Configuration instance to collect resource metadata.

    • Constraints: The maximum length is 44 characters. The minimum length is 44 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.
    additionalScopes List<Property Map>
    The additional scope that enables resource collection for Enterprise acccounts.

    • Constraints: The maximum length is 10 items. The minimum length is 0 items. Nested schema for additional_scope:
    configAggregatorSettingsId String
    The unique identifier of the config_aggregator_settings.
    region String
    The region of the configuration aggregator instance.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ConfigAggregatorSettings Resource

    Get an existing ConfigAggregatorSettings 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?: ConfigAggregatorSettingsState, opts?: CustomResourceOptions): ConfigAggregatorSettings
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            additional_scopes: Optional[Sequence[ConfigAggregatorSettingsAdditionalScopeArgs]] = None,
            config_aggregator_settings_id: Optional[str] = None,
            instance_id: Optional[str] = None,
            region: Optional[str] = None,
            resource_collection_enabled: Optional[bool] = None,
            resource_collection_regions: Optional[Sequence[str]] = None,
            trusted_profile_id: Optional[str] = None) -> ConfigAggregatorSettings
    func GetConfigAggregatorSettings(ctx *Context, name string, id IDInput, state *ConfigAggregatorSettingsState, opts ...ResourceOption) (*ConfigAggregatorSettings, error)
    public static ConfigAggregatorSettings Get(string name, Input<string> id, ConfigAggregatorSettingsState? state, CustomResourceOptions? opts = null)
    public static ConfigAggregatorSettings get(String name, Output<String> id, ConfigAggregatorSettingsState state, CustomResourceOptions options)
    resources:  _:    type: ibm:ConfigAggregatorSettings    get:      id: ${id}
    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:
    AdditionalScopes List<ConfigAggregatorSettingsAdditionalScope>
    The additional scope that enables resource collection for Enterprise acccounts.

    • Constraints: The maximum length is 10 items. The minimum length is 0 items. Nested schema for additional_scope:
    ConfigAggregatorSettingsId string
    The unique identifier of the config_aggregator_settings.
    InstanceId string
    The GUID of the Configuration Aggregator instance.
    Region string
    The region of the configuration aggregator instance.
    ResourceCollectionEnabled bool
    The field denoting if the resource collection is enabled.
    ResourceCollectionRegions List<string>
    The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    TrustedProfileId string
    The trusted profile id that provides Reader access to the App Configuration instance to collect resource metadata.

    • Constraints: The maximum length is 44 characters. The minimum length is 44 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.
    AdditionalScopes []ConfigAggregatorSettingsAdditionalScopeArgs
    The additional scope that enables resource collection for Enterprise acccounts.

    • Constraints: The maximum length is 10 items. The minimum length is 0 items. Nested schema for additional_scope:
    ConfigAggregatorSettingsId string
    The unique identifier of the config_aggregator_settings.
    InstanceId string
    The GUID of the Configuration Aggregator instance.
    Region string
    The region of the configuration aggregator instance.
    ResourceCollectionEnabled bool
    The field denoting if the resource collection is enabled.
    ResourceCollectionRegions []string
    The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    TrustedProfileId string
    The trusted profile id that provides Reader access to the App Configuration instance to collect resource metadata.

    • Constraints: The maximum length is 44 characters. The minimum length is 44 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.
    additionalScopes List<ConfigAggregatorSettingsAdditionalScope>
    The additional scope that enables resource collection for Enterprise acccounts.

    • Constraints: The maximum length is 10 items. The minimum length is 0 items. Nested schema for additional_scope:
    configAggregatorSettingsId String
    The unique identifier of the config_aggregator_settings.
    instanceId String
    The GUID of the Configuration Aggregator instance.
    region String
    The region of the configuration aggregator instance.
    resourceCollectionEnabled Boolean
    The field denoting if the resource collection is enabled.
    resourceCollectionRegions List<String>
    The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    trustedProfileId String
    The trusted profile id that provides Reader access to the App Configuration instance to collect resource metadata.

    • Constraints: The maximum length is 44 characters. The minimum length is 44 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.
    additionalScopes ConfigAggregatorSettingsAdditionalScope[]
    The additional scope that enables resource collection for Enterprise acccounts.

    • Constraints: The maximum length is 10 items. The minimum length is 0 items. Nested schema for additional_scope:
    configAggregatorSettingsId string
    The unique identifier of the config_aggregator_settings.
    instanceId string
    The GUID of the Configuration Aggregator instance.
    region string
    The region of the configuration aggregator instance.
    resourceCollectionEnabled boolean
    The field denoting if the resource collection is enabled.
    resourceCollectionRegions string[]
    The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    trustedProfileId string
    The trusted profile id that provides Reader access to the App Configuration instance to collect resource metadata.

    • Constraints: The maximum length is 44 characters. The minimum length is 44 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.
    additional_scopes Sequence[ConfigAggregatorSettingsAdditionalScopeArgs]
    The additional scope that enables resource collection for Enterprise acccounts.

    • Constraints: The maximum length is 10 items. The minimum length is 0 items. Nested schema for additional_scope:
    config_aggregator_settings_id str
    The unique identifier of the config_aggregator_settings.
    instance_id str
    The GUID of the Configuration Aggregator instance.
    region str
    The region of the configuration aggregator instance.
    resource_collection_enabled bool
    The field denoting if the resource collection is enabled.
    resource_collection_regions Sequence[str]
    The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    trusted_profile_id str
    The trusted profile id that provides Reader access to the App Configuration instance to collect resource metadata.

    • Constraints: The maximum length is 44 characters. The minimum length is 44 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.
    additionalScopes List<Property Map>
    The additional scope that enables resource collection for Enterprise acccounts.

    • Constraints: The maximum length is 10 items. The minimum length is 0 items. Nested schema for additional_scope:
    configAggregatorSettingsId String
    The unique identifier of the config_aggregator_settings.
    instanceId String
    The GUID of the Configuration Aggregator instance.
    region String
    The region of the configuration aggregator instance.
    resourceCollectionEnabled Boolean
    The field denoting if the resource collection is enabled.
    resourceCollectionRegions List<String>
    The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    trustedProfileId String
    The trusted profile id that provides Reader access to the App Configuration instance to collect resource metadata.

    • Constraints: The maximum length is 44 characters. The minimum length is 44 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.

    Supporting Types

    ConfigAggregatorSettingsAdditionalScope, ConfigAggregatorSettingsAdditionalScopeArgs

    EnterpriseId string
    The Enterprise ID.

    • Constraints: The maximum length is 32 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z0-9]/.
    ProfileTemplate ConfigAggregatorSettingsAdditionalScopeProfileTemplate
    The Profile Template details applied on the enterprise account. Nested schema for profile_template:
    Type string
    The type of scope. Currently allowed value is Enterprise.

    • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z0-9]/.
    EnterpriseId string
    The Enterprise ID.

    • Constraints: The maximum length is 32 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z0-9]/.
    ProfileTemplate ConfigAggregatorSettingsAdditionalScopeProfileTemplate
    The Profile Template details applied on the enterprise account. Nested schema for profile_template:
    Type string
    The type of scope. Currently allowed value is Enterprise.

    • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z0-9]/.
    enterpriseId String
    The Enterprise ID.

    • Constraints: The maximum length is 32 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z0-9]/.
    profileTemplate ConfigAggregatorSettingsAdditionalScopeProfileTemplate
    The Profile Template details applied on the enterprise account. Nested schema for profile_template:
    type String
    The type of scope. Currently allowed value is Enterprise.

    • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z0-9]/.
    enterpriseId string
    The Enterprise ID.

    • Constraints: The maximum length is 32 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z0-9]/.
    profileTemplate ConfigAggregatorSettingsAdditionalScopeProfileTemplate
    The Profile Template details applied on the enterprise account. Nested schema for profile_template:
    type string
    The type of scope. Currently allowed value is Enterprise.

    • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z0-9]/.
    enterprise_id str
    The Enterprise ID.

    • Constraints: The maximum length is 32 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z0-9]/.
    profile_template ConfigAggregatorSettingsAdditionalScopeProfileTemplate
    The Profile Template details applied on the enterprise account. Nested schema for profile_template:
    type str
    The type of scope. Currently allowed value is Enterprise.

    • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z0-9]/.
    enterpriseId String
    The Enterprise ID.

    • Constraints: The maximum length is 32 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z0-9]/.
    profileTemplate Property Map
    The Profile Template details applied on the enterprise account. Nested schema for profile_template:
    type String
    The type of scope. Currently allowed value is Enterprise.

    • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z0-9]/.

    ConfigAggregatorSettingsAdditionalScopeProfileTemplate, ConfigAggregatorSettingsAdditionalScopeProfileTemplateArgs

    Id string
    The Profile Template ID created in the enterprise account that provides access to App Configuration instance for resource collection.

    • Constraints: The maximum length is 52 characters. The minimum length is 52 characters. The value must match regular expression /[a-zA-Z0-9-]/.
    TrustedProfileId string
    The trusted profile ID that provides access to App Configuration instance to retrieve template information.

    • Constraints: The maximum length is 44 characters. The minimum length is 44 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.
    Id string
    The Profile Template ID created in the enterprise account that provides access to App Configuration instance for resource collection.

    • Constraints: The maximum length is 52 characters. The minimum length is 52 characters. The value must match regular expression /[a-zA-Z0-9-]/.
    TrustedProfileId string
    The trusted profile ID that provides access to App Configuration instance to retrieve template information.

    • Constraints: The maximum length is 44 characters. The minimum length is 44 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.
    id String
    The Profile Template ID created in the enterprise account that provides access to App Configuration instance for resource collection.

    • Constraints: The maximum length is 52 characters. The minimum length is 52 characters. The value must match regular expression /[a-zA-Z0-9-]/.
    trustedProfileId String
    The trusted profile ID that provides access to App Configuration instance to retrieve template information.

    • Constraints: The maximum length is 44 characters. The minimum length is 44 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.
    id string
    The Profile Template ID created in the enterprise account that provides access to App Configuration instance for resource collection.

    • Constraints: The maximum length is 52 characters. The minimum length is 52 characters. The value must match regular expression /[a-zA-Z0-9-]/.
    trustedProfileId string
    The trusted profile ID that provides access to App Configuration instance to retrieve template information.

    • Constraints: The maximum length is 44 characters. The minimum length is 44 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.
    id str
    The Profile Template ID created in the enterprise account that provides access to App Configuration instance for resource collection.

    • Constraints: The maximum length is 52 characters. The minimum length is 52 characters. The value must match regular expression /[a-zA-Z0-9-]/.
    trusted_profile_id str
    The trusted profile ID that provides access to App Configuration instance to retrieve template information.

    • Constraints: The maximum length is 44 characters. The minimum length is 44 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.
    id String
    The Profile Template ID created in the enterprise account that provides access to App Configuration instance for resource collection.

    • Constraints: The maximum length is 52 characters. The minimum length is 52 characters. The value must match regular expression /[a-zA-Z0-9-]/.
    trustedProfileId String
    The trusted profile ID that provides access to App Configuration instance to retrieve template information.

    • Constraints: The maximum length is 44 characters. The minimum length is 44 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.

    Import

    You can import the ibm_config_aggregator_settings resource by using region and instance_id.

    Syntax

    
    ```sh
    $ pulumi import ibm:index/configAggregatorSettings:ConfigAggregatorSettings config_aggregator_settings /
    ```
    
    

    Example

    $ pulumi import ibm:index/configAggregatorSettings:ConfigAggregatorSettings config_aggregator_settings us-south/23243-3223-2323-333
    

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

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud