1. Packages
  2. Packages
  3. Scaleway
  4. API Docs
  5. observability
  6. getConfig
Viewing docs for Scaleway v1.50.0
published on Tuesday, Jun 2, 2026 by pulumiverse
scaleway logo
Viewing docs for Scaleway v1.50.0
published on Tuesday, Jun 2, 2026 by pulumiverse

    Gets regional Cockpit configuration, including retention limits and defaults for custom and product data sources.

    Use this data source to validate retentionDays values before creating or updating scaleway.observability.Source resources.

    Refer to Cockpit’s product documentation and API documentation for more information.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    const main = scaleway.observability.getConfig({
        region: "fr-par",
    });
    const metrics = new scaleway.observability.Source("metrics", {
        name: "my-metrics",
        type: "metrics",
        retentionDays: main.then(main => main.customMetricsRetentions?.[0]?.defaultDays),
    });
    export const customMetricsRetentionBounds = main.then(main => main.customMetricsRetentions?.[0]);
    
    import pulumi
    import pulumi_scaleway as scaleway
    import pulumiverse_scaleway as scaleway
    
    main = scaleway.observability.get_config(region="fr-par")
    metrics = scaleway.observability.Source("metrics",
        name="my-metrics",
        type="metrics",
        retention_days=main.custom_metrics_retentions[0].default_days)
    pulumi.export("customMetricsRetentionBounds", main.custom_metrics_retentions[0])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/observability"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		main, err := observability.GetConfig(ctx, &observability.GetConfigArgs{
    			Region: pulumi.StringRef("fr-par"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = observability.NewSource(ctx, "metrics", &observability.SourceArgs{
    			Name:          pulumi.String("my-metrics"),
    			Type:          pulumi.String("metrics"),
    			RetentionDays: pulumi.Int(pulumi.Int(main.CustomMetricsRetentions[0].DefaultDays)),
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("customMetricsRetentionBounds", main.CustomMetricsRetentions[0])
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scaleway = Pulumiverse.Scaleway;
    
    return await Deployment.RunAsync(() => 
    {
        var main = Scaleway.Observability.GetConfig.Invoke(new()
        {
            Region = "fr-par",
        });
    
        var metrics = new Scaleway.Observability.Source("metrics", new()
        {
            Name = "my-metrics",
            Type = "metrics",
            RetentionDays = main.Apply(getConfigResult => getConfigResult.CustomMetricsRetentions[0]?.DefaultDays),
        });
    
        return new Dictionary<string, object?>
        {
            ["customMetricsRetentionBounds"] = main.Apply(getConfigResult => getConfigResult.CustomMetricsRetentions[0]),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scaleway.observability.ObservabilityFunctions;
    import com.pulumi.scaleway.observability.inputs.GetConfigArgs;
    import com.pulumi.scaleway.observability.Source;
    import com.pulumi.scaleway.observability.SourceArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 main = ObservabilityFunctions.getConfig(GetConfigArgs.builder()
                .region("fr-par")
                .build());
    
            var metrics = new Source("metrics", SourceArgs.builder()
                .name("my-metrics")
                .type("metrics")
                .retentionDays(main.customMetricsRetentions()[0].defaultDays())
                .build());
    
            ctx.export("customMetricsRetentionBounds", main.customMetricsRetentions()[0]);
        }
    }
    
    resources:
      metrics:
        type: scaleway:observability:Source
        properties:
          name: my-metrics
          type: metrics
          retentionDays: ${main.customMetricsRetentions[0].defaultDays}
    variables:
      main:
        fn::invoke:
          function: scaleway:observability:getConfig
          arguments:
            region: fr-par
    outputs:
      customMetricsRetentionBounds: ${main.customMetricsRetentions[0]}
    
    Example coming soon!
    

    Using getConfig

    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 getConfig(args: GetConfigArgs, opts?: InvokeOptions): Promise<GetConfigResult>
    function getConfigOutput(args: GetConfigOutputArgs, opts?: InvokeOptions): Output<GetConfigResult>
    def get_config(region: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetConfigResult
    def get_config_output(region: pulumi.Input[Optional[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetConfigResult]
    func GetConfig(ctx *Context, args *GetConfigArgs, opts ...InvokeOption) (*GetConfigResult, error)
    func GetConfigOutput(ctx *Context, args *GetConfigOutputArgs, opts ...InvokeOption) GetConfigResultOutput

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

    public static class GetConfig 
    {
        public static Task<GetConfigResult> InvokeAsync(GetConfigArgs args, InvokeOptions? opts = null)
        public static Output<GetConfigResult> Invoke(GetConfigInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetConfigResult> getConfig(GetConfigArgs args, InvokeOptions options)
    public static Output<GetConfigResult> getConfig(GetConfigArgs args, InvokeOptions options)
    
    fn::invoke:
      function: scaleway:observability/getConfig:getConfig
      arguments:
        # arguments dictionary
    data "scaleway_observability_getconfig" "name" {
        # arguments
    }

    The following arguments are supported:

    Region string
    The region to query. Defaults to the region configured in the provider.
    Region string
    The region to query. Defaults to the region configured in the provider.
    region string
    The region to query. Defaults to the region configured in the provider.
    region String
    The region to query. Defaults to the region configured in the provider.
    region string
    The region to query. Defaults to the region configured in the provider.
    region str
    The region to query. Defaults to the region configured in the provider.
    region String
    The region to query. Defaults to the region configured in the provider.

    getConfig Result

    The following output properties are available:

    CustomLogsRetentions List<Pulumiverse.Scaleway.Observability.Outputs.GetConfigCustomLogsRetention>
    Retention limits and default for custom logs data sources. (see below)
    CustomMetricsRetentions List<Pulumiverse.Scaleway.Observability.Outputs.GetConfigCustomMetricsRetention>
    Retention limits and default for custom metrics data sources. (see below)
    CustomTracesRetentions List<Pulumiverse.Scaleway.Observability.Outputs.GetConfigCustomTracesRetention>
    Retention limits and default for custom traces data sources. (see below)
    Id string
    The provider-assigned unique ID for this managed resource.
    ProductLogsRetentions List<Pulumiverse.Scaleway.Observability.Outputs.GetConfigProductLogsRetention>
    Retention limits and default for Scaleway product logs data sources. (see below)
    ProductMetricsRetentions List<Pulumiverse.Scaleway.Observability.Outputs.GetConfigProductMetricsRetention>
    Retention limits and default for Scaleway product metrics data sources. (see below)
    Region string
    CustomLogsRetentions []GetConfigCustomLogsRetention
    Retention limits and default for custom logs data sources. (see below)
    CustomMetricsRetentions []GetConfigCustomMetricsRetention
    Retention limits and default for custom metrics data sources. (see below)
    CustomTracesRetentions []GetConfigCustomTracesRetention
    Retention limits and default for custom traces data sources. (see below)
    Id string
    The provider-assigned unique ID for this managed resource.
    ProductLogsRetentions []GetConfigProductLogsRetention
    Retention limits and default for Scaleway product logs data sources. (see below)
    ProductMetricsRetentions []GetConfigProductMetricsRetention
    Retention limits and default for Scaleway product metrics data sources. (see below)
    Region string
    custom_logs_retentions list(object)
    Retention limits and default for custom logs data sources. (see below)
    custom_metrics_retentions list(object)
    Retention limits and default for custom metrics data sources. (see below)
    custom_traces_retentions list(object)
    Retention limits and default for custom traces data sources. (see below)
    id string
    The provider-assigned unique ID for this managed resource.
    product_logs_retentions list(object)
    Retention limits and default for Scaleway product logs data sources. (see below)
    product_metrics_retentions list(object)
    Retention limits and default for Scaleway product metrics data sources. (see below)
    region string
    customLogsRetentions List<GetConfigCustomLogsRetention>
    Retention limits and default for custom logs data sources. (see below)
    customMetricsRetentions List<GetConfigCustomMetricsRetention>
    Retention limits and default for custom metrics data sources. (see below)
    customTracesRetentions List<GetConfigCustomTracesRetention>
    Retention limits and default for custom traces data sources. (see below)
    id String
    The provider-assigned unique ID for this managed resource.
    productLogsRetentions List<GetConfigProductLogsRetention>
    Retention limits and default for Scaleway product logs data sources. (see below)
    productMetricsRetentions List<GetConfigProductMetricsRetention>
    Retention limits and default for Scaleway product metrics data sources. (see below)
    region String
    customLogsRetentions GetConfigCustomLogsRetention[]
    Retention limits and default for custom logs data sources. (see below)
    customMetricsRetentions GetConfigCustomMetricsRetention[]
    Retention limits and default for custom metrics data sources. (see below)
    customTracesRetentions GetConfigCustomTracesRetention[]
    Retention limits and default for custom traces data sources. (see below)
    id string
    The provider-assigned unique ID for this managed resource.
    productLogsRetentions GetConfigProductLogsRetention[]
    Retention limits and default for Scaleway product logs data sources. (see below)
    productMetricsRetentions GetConfigProductMetricsRetention[]
    Retention limits and default for Scaleway product metrics data sources. (see below)
    region string
    custom_logs_retentions Sequence[GetConfigCustomLogsRetention]
    Retention limits and default for custom logs data sources. (see below)
    custom_metrics_retentions Sequence[GetConfigCustomMetricsRetention]
    Retention limits and default for custom metrics data sources. (see below)
    custom_traces_retentions Sequence[GetConfigCustomTracesRetention]
    Retention limits and default for custom traces data sources. (see below)
    id str
    The provider-assigned unique ID for this managed resource.
    product_logs_retentions Sequence[GetConfigProductLogsRetention]
    Retention limits and default for Scaleway product logs data sources. (see below)
    product_metrics_retentions Sequence[GetConfigProductMetricsRetention]
    Retention limits and default for Scaleway product metrics data sources. (see below)
    region str
    customLogsRetentions List<Property Map>
    Retention limits and default for custom logs data sources. (see below)
    customMetricsRetentions List<Property Map>
    Retention limits and default for custom metrics data sources. (see below)
    customTracesRetentions List<Property Map>
    Retention limits and default for custom traces data sources. (see below)
    id String
    The provider-assigned unique ID for this managed resource.
    productLogsRetentions List<Property Map>
    Retention limits and default for Scaleway product logs data sources. (see below)
    productMetricsRetentions List<Property Map>
    Retention limits and default for Scaleway product metrics data sources. (see below)
    region String

    Supporting Types

    GetConfigCustomLogsRetention

    DefaultDays int
    Default retention in days.
    MaxDays int
    Maximum retention in days.
    MinDays int
    Minimum retention in days.
    DefaultDays int
    Default retention in days.
    MaxDays int
    Maximum retention in days.
    MinDays int
    Minimum retention in days.
    default_days number
    Default retention in days.
    max_days number
    Maximum retention in days.
    min_days number
    Minimum retention in days.
    defaultDays Integer
    Default retention in days.
    maxDays Integer
    Maximum retention in days.
    minDays Integer
    Minimum retention in days.
    defaultDays number
    Default retention in days.
    maxDays number
    Maximum retention in days.
    minDays number
    Minimum retention in days.
    default_days int
    Default retention in days.
    max_days int
    Maximum retention in days.
    min_days int
    Minimum retention in days.
    defaultDays Number
    Default retention in days.
    maxDays Number
    Maximum retention in days.
    minDays Number
    Minimum retention in days.

    GetConfigCustomMetricsRetention

    DefaultDays int
    Default retention in days.
    MaxDays int
    Maximum retention in days.
    MinDays int
    Minimum retention in days.
    DefaultDays int
    Default retention in days.
    MaxDays int
    Maximum retention in days.
    MinDays int
    Minimum retention in days.
    default_days number
    Default retention in days.
    max_days number
    Maximum retention in days.
    min_days number
    Minimum retention in days.
    defaultDays Integer
    Default retention in days.
    maxDays Integer
    Maximum retention in days.
    minDays Integer
    Minimum retention in days.
    defaultDays number
    Default retention in days.
    maxDays number
    Maximum retention in days.
    minDays number
    Minimum retention in days.
    default_days int
    Default retention in days.
    max_days int
    Maximum retention in days.
    min_days int
    Minimum retention in days.
    defaultDays Number
    Default retention in days.
    maxDays Number
    Maximum retention in days.
    minDays Number
    Minimum retention in days.

    GetConfigCustomTracesRetention

    DefaultDays int
    Default retention in days.
    MaxDays int
    Maximum retention in days.
    MinDays int
    Minimum retention in days.
    DefaultDays int
    Default retention in days.
    MaxDays int
    Maximum retention in days.
    MinDays int
    Minimum retention in days.
    default_days number
    Default retention in days.
    max_days number
    Maximum retention in days.
    min_days number
    Minimum retention in days.
    defaultDays Integer
    Default retention in days.
    maxDays Integer
    Maximum retention in days.
    minDays Integer
    Minimum retention in days.
    defaultDays number
    Default retention in days.
    maxDays number
    Maximum retention in days.
    minDays number
    Minimum retention in days.
    default_days int
    Default retention in days.
    max_days int
    Maximum retention in days.
    min_days int
    Minimum retention in days.
    defaultDays Number
    Default retention in days.
    maxDays Number
    Maximum retention in days.
    minDays Number
    Minimum retention in days.

    GetConfigProductLogsRetention

    DefaultDays int
    Default retention in days.
    MaxDays int
    Maximum retention in days.
    MinDays int
    Minimum retention in days.
    DefaultDays int
    Default retention in days.
    MaxDays int
    Maximum retention in days.
    MinDays int
    Minimum retention in days.
    default_days number
    Default retention in days.
    max_days number
    Maximum retention in days.
    min_days number
    Minimum retention in days.
    defaultDays Integer
    Default retention in days.
    maxDays Integer
    Maximum retention in days.
    minDays Integer
    Minimum retention in days.
    defaultDays number
    Default retention in days.
    maxDays number
    Maximum retention in days.
    minDays number
    Minimum retention in days.
    default_days int
    Default retention in days.
    max_days int
    Maximum retention in days.
    min_days int
    Minimum retention in days.
    defaultDays Number
    Default retention in days.
    maxDays Number
    Maximum retention in days.
    minDays Number
    Minimum retention in days.

    GetConfigProductMetricsRetention

    DefaultDays int
    Default retention in days.
    MaxDays int
    Maximum retention in days.
    MinDays int
    Minimum retention in days.
    DefaultDays int
    Default retention in days.
    MaxDays int
    Maximum retention in days.
    MinDays int
    Minimum retention in days.
    default_days number
    Default retention in days.
    max_days number
    Maximum retention in days.
    min_days number
    Minimum retention in days.
    defaultDays Integer
    Default retention in days.
    maxDays Integer
    Maximum retention in days.
    minDays Integer
    Minimum retention in days.
    defaultDays number
    Default retention in days.
    maxDays number
    Maximum retention in days.
    minDays number
    Minimum retention in days.
    default_days int
    Default retention in days.
    max_days int
    Maximum retention in days.
    min_days int
    Minimum retention in days.
    defaultDays Number
    Default retention in days.
    maxDays Number
    Maximum retention in days.
    minDays Number
    Minimum retention in days.

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Viewing docs for Scaleway v1.50.0
    published on Tuesday, Jun 2, 2026 by pulumiverse

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial