Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getConfigAggregatorSettings
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getConfigAggregatorSettings

Explore with Pulumi AI

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

    Provides a read-only data source to retrieve information about config_aggregator_settings. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

    Example Usage

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

const configAggregatorSettings = ibm.getConfigAggregatorSettings({
    instanceId: _var.instance_id,
    region: _var.region,
});

    import pulumi
import pulumi_ibm as ibm

config_aggregator_settings = ibm.get_config_aggregator_settings(instance_id=var["instance_id"],
    region=var["region"])

    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.LookupConfigAggregatorSettings(ctx, &ibm.LookupConfigAggregatorSettingsArgs{
			InstanceId: _var.Instance_id,
			Region:     pulumi.StringRef(_var.Region),
		}, nil)
		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 configAggregatorSettings = Ibm.GetConfigAggregatorSettings.Invoke(new()
    {
        InstanceId = @var.Instance_id,
        Region = @var.Region,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetConfigAggregatorSettingsArgs;
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 configAggregatorSettings = IbmFunctions.getConfigAggregatorSettings(GetConfigAggregatorSettingsArgs.builder()
            .instanceId(var_.instance_id())
            .region(var_.region())
            .build());

    }
}

    variables:
  configAggregatorSettings:
    fn::invoke:
      function: ibm:getConfigAggregatorSettings
      arguments:
        instanceId: ${var.instance_id}
        region: ${var.region}

    Using getConfigAggregatorSettings

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getConfigAggregatorSettings(args: GetConfigAggregatorSettingsArgs, opts?: InvokeOptions): Promise<GetConfigAggregatorSettingsResult>
function getConfigAggregatorSettingsOutput(args: GetConfigAggregatorSettingsOutputArgs, opts?: InvokeOptions): Output<GetConfigAggregatorSettingsResult>
    def get_config_aggregator_settings(id: Optional[str] = None,
                                   instance_id: Optional[str] = None,
                                   region: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetConfigAggregatorSettingsResult
def get_config_aggregator_settings_output(id: Optional[pulumi.Input[str]] = None,
                                   instance_id: Optional[pulumi.Input[str]] = None,
                                   region: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetConfigAggregatorSettingsResult]
    func LookupConfigAggregatorSettings(ctx *Context, args *LookupConfigAggregatorSettingsArgs, opts ...InvokeOption) (*LookupConfigAggregatorSettingsResult, error)
func LookupConfigAggregatorSettingsOutput(ctx *Context, args *LookupConfigAggregatorSettingsOutputArgs, opts ...InvokeOption) LookupConfigAggregatorSettingsResultOutput

    > Note: This function is named LookupConfigAggregatorSettings in the Go SDK.

    public static class GetConfigAggregatorSettings 
{
    public static Task<GetConfigAggregatorSettingsResult> InvokeAsync(GetConfigAggregatorSettingsArgs args, InvokeOptions? opts = null)
    public static Output<GetConfigAggregatorSettingsResult> Invoke(GetConfigAggregatorSettingsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetConfigAggregatorSettingsResult> getConfigAggregatorSettings(GetConfigAggregatorSettingsArgs args, InvokeOptions options)
public static Output<GetConfigAggregatorSettingsResult> getConfigAggregatorSettings(GetConfigAggregatorSettingsArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getConfigAggregatorSettings:getConfigAggregatorSettings
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceId string
    (Required, Forces new resource, String) The GUID of the Configuration Aggregator instance.
    Id string
    (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-]/.
    Region string
    (Optional, Forces new resource, String) The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    InstanceId string
    (Required, Forces new resource, String) The GUID of the Configuration Aggregator instance.
    Id string
    (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-]/.
    Region string
    (Optional, Forces new resource, String) The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    instanceId String
    (Required, Forces new resource, String) The GUID of the Configuration Aggregator instance.
    id String
    (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-]/.
    region String
    (Optional, Forces new resource, String) The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    instanceId string
    (Required, Forces new resource, String) The GUID of the Configuration Aggregator instance.
    id string
    (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-]/.
    region string
    (Optional, Forces new resource, String) The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    instance_id str
    (Required, Forces new resource, String) The GUID of the Configuration Aggregator instance.
    id str
    (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-]/.
    region str
    (Optional, Forces new resource, String) The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    instanceId String
    (Required, Forces new resource, String) The GUID of the Configuration Aggregator instance.
    id String
    (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-]/.
    region String
    (Optional, Forces new resource, String) The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.

    getConfigAggregatorSettings Result

    The following output properties are available:

    AdditionalScopes List<GetConfigAggregatorSettingsAdditionalScope>
    (List) 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:
    Id string
    (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-]/.
    InstanceId string
    (Required, Forces new resource, String) The GUID of the Configuration Aggregator instance.
    LastUpdated string
    (String) The last time the settings was last updated.
    Region string
    (Optional, Forces new resource, String) The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    Regions List<string>
    ResourceCollectionEnabled bool
    (Boolean) The field to check if the resource collection is enabled.
    TrustedProfileId string
    (String) The trusted profile ID that provides access to App Configuration instance to retrieve 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 []GetConfigAggregatorSettingsAdditionalScope
    (List) 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:
    Id string
    (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-]/.
    InstanceId string
    (Required, Forces new resource, String) The GUID of the Configuration Aggregator instance.
    LastUpdated string
    (String) The last time the settings was last updated.
    Region string
    (Optional, Forces new resource, String) The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    Regions []string
    ResourceCollectionEnabled bool
    (Boolean) The field to check if the resource collection is enabled.
    TrustedProfileId string
    (String) The trusted profile ID that provides access to App Configuration instance to retrieve 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<GetConfigAggregatorSettingsAdditionalScope>
    (List) 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:
    id String
    (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-]/.
    instanceId String
    (Required, Forces new resource, String) The GUID of the Configuration Aggregator instance.
    lastUpdated String
    (String) The last time the settings was last updated.
    region String
    (Optional, Forces new resource, String) The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    regions List<String>
    resourceCollectionEnabled Boolean
    (Boolean) The field to check if the resource collection is enabled.
    trustedProfileId String
    (String) The trusted profile ID that provides access to App Configuration instance to retrieve 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 GetConfigAggregatorSettingsAdditionalScope[]
    (List) 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:
    id string
    (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-]/.
    instanceId string
    (Required, Forces new resource, String) The GUID of the Configuration Aggregator instance.
    lastUpdated string
    (String) The last time the settings was last updated.
    region string
    (Optional, Forces new resource, String) The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    regions string[]
    resourceCollectionEnabled boolean
    (Boolean) The field to check if the resource collection is enabled.
    trustedProfileId string
    (String) The trusted profile ID that provides access to App Configuration instance to retrieve 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[GetConfigAggregatorSettingsAdditionalScope]
    (List) 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:
    id str
    (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-]/.
    instance_id str
    (Required, Forces new resource, String) The GUID of the Configuration Aggregator instance.
    last_updated str
    (String) The last time the settings was last updated.
    region str
    (Optional, Forces new resource, String) The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    regions Sequence[str]
    resource_collection_enabled bool
    (Boolean) The field to check if the resource collection is enabled.
    trusted_profile_id str
    (String) The trusted profile ID that provides access to App Configuration instance to retrieve 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>
    (List) 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:
    id String
    (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-]/.
    instanceId String
    (Required, Forces new resource, String) The GUID of the Configuration Aggregator instance.
    lastUpdated String
    (String) The last time the settings was last updated.
    region String
    (Optional, Forces new resource, String) The region of the Configuration Aggregator instance. If not provided defaults to the region defined in the IBM provider configuration.
    regions List<String>
    resourceCollectionEnabled Boolean
    (Boolean) The field to check if the resource collection is enabled.
    trustedProfileId String
    (String) The trusted profile ID that provides access to App Configuration instance to retrieve 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

    GetConfigAggregatorSettingsAdditionalScope

    EnterpriseId string
    (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]/.
    ProfileTemplates List<GetConfigAggregatorSettingsAdditionalScopeProfileTemplate>
    (List) The Profile Template details applied on the enterprise account. Nested schema for profile_template:
    Type string
    (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
    (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]/.
    ProfileTemplates []GetConfigAggregatorSettingsAdditionalScopeProfileTemplate
    (List) The Profile Template details applied on the enterprise account. Nested schema for profile_template:
    Type string
    (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
    (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]/.
    profileTemplates List<GetConfigAggregatorSettingsAdditionalScopeProfileTemplate>
    (List) The Profile Template details applied on the enterprise account. Nested schema for profile_template:
    type String
    (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
    (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]/.
    profileTemplates GetConfigAggregatorSettingsAdditionalScopeProfileTemplate[]
    (List) The Profile Template details applied on the enterprise account. Nested schema for profile_template:
    type string
    (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
    (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]/.
    profile_templates Sequence[GetConfigAggregatorSettingsAdditionalScopeProfileTemplate]
    (List) The Profile Template details applied on the enterprise account. Nested schema for profile_template:
    type str
    (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
    (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]/.
    profileTemplates List<Property Map>
    (List) The Profile Template details applied on the enterprise account. Nested schema for profile_template:
    type String
    (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]/.

    GetConfigAggregatorSettingsAdditionalScopeProfileTemplate

    Id string
    (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
    (String) The trusted profile ID that provides access to App Configuration instance to retrieve 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-]*$/.
    Id string
    (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
    (String) The trusted profile ID that provides access to App Configuration instance to retrieve 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-]*$/.
    id String
    (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
    (String) The trusted profile ID that provides access to App Configuration instance to retrieve 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-]*$/.
    id string
    (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
    (String) The trusted profile ID that provides access to App Configuration instance to retrieve 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-]*$/.
    id str
    (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-]/.
    trusted_profile_id str
    (String) The trusted profile ID that provides access to App Configuration instance to retrieve 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-]*$/.
    id String
    (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
    (String) The trusted profile ID that provides access to App Configuration instance to retrieve 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-]*$/.

    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
    ibm-cloud/terraform-provider-ibm