Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gitlab Provider
  3. API Docs
  4. getInstanceVariables
GitLab v8.11.0 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-gitlab

gitlab.getInstanceVariables

Explore with Pulumi AI

gitlab logo
GitLab v8.11.0 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-gitlab

    The gitlab.getInstanceVariables data source allows to retrieve all instance-level CI/CD variables.

    Upstream API: GitLab REST API docs

    Example Usage

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

const vars = gitlab.getInstanceVariables({});

    import pulumi
import pulumi_gitlab as gitlab

vars = gitlab.get_instance_variables()

    package main

import (
	"github.com/pulumi/pulumi-gitlab/sdk/v8/go/gitlab"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gitlab.GetInstanceVariables(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var vars = GitLab.GetInstanceVariables.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.GitlabFunctions;
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 vars = GitlabFunctions.getInstanceVariables(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference);

    }
}

    variables:
  vars:
    fn::invoke:
      function: gitlab:getInstanceVariables
      arguments: {}

    Using getInstanceVariables

    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 getInstanceVariables(opts?: InvokeOptions): Promise<GetInstanceVariablesResult>
function getInstanceVariablesOutput(opts?: InvokeOptions): Output<GetInstanceVariablesResult>
    def get_instance_variables(opts: Optional[InvokeOptions] = None) -> GetInstanceVariablesResult
def get_instance_variables_output(opts: Optional[InvokeOptions] = None) -> Output[GetInstanceVariablesResult]
    func GetInstanceVariables(ctx *Context, opts ...InvokeOption) (*GetInstanceVariablesResult, error)
func GetInstanceVariablesOutput(ctx *Context, opts ...InvokeOption) GetInstanceVariablesResultOutput

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

    public static class GetInstanceVariables 
{
    public static Task<GetInstanceVariablesResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetInstanceVariablesResult> Invoke(InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInstanceVariablesResult> getInstanceVariables(InvokeOptions options)
public static Output<GetInstanceVariablesResult> getInstanceVariables(InvokeOptions options)

    fn::invoke:
  function: gitlab:index/getInstanceVariables:getInstanceVariables
  arguments:
    # arguments dictionary

    getInstanceVariables Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Variables List<Pulumi.GitLab.Outputs.GetInstanceVariablesVariable>
    The list of variables returned by the search
    Id string
    The provider-assigned unique ID for this managed resource.
    Variables []GetInstanceVariablesVariable
    The list of variables returned by the search
    id String
    The provider-assigned unique ID for this managed resource.
    variables List<GetInstanceVariablesVariable>
    The list of variables returned by the search
    id string
    The provider-assigned unique ID for this managed resource.
    variables GetInstanceVariablesVariable[]
    The list of variables returned by the search
    id str
    The provider-assigned unique ID for this managed resource.
    variables Sequence[GetInstanceVariablesVariable]
    The list of variables returned by the search
    id String
    The provider-assigned unique ID for this managed resource.
    variables List<Property Map>
    The list of variables returned by the search

    Supporting Types

    GetInstanceVariablesVariable

    Description string
    The description of the variable. Maximum of 255 characters.
    Key string
    The name of the variable.
    Masked bool
    If set to true, the value of the variable will be hidden in job logs. The value must meet the masking requirements. Defaults to false.
    Protected bool
    If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.
    Raw bool
    Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
    Value string
    The value of the variable.
    VariableType string
    The type of a variable. Valid values are: env_var, file. Default is env_var.
    Description string
    The description of the variable. Maximum of 255 characters.
    Key string
    The name of the variable.
    Masked bool
    If set to true, the value of the variable will be hidden in job logs. The value must meet the masking requirements. Defaults to false.
    Protected bool
    If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.
    Raw bool
    Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
    Value string
    The value of the variable.
    VariableType string
    The type of a variable. Valid values are: env_var, file. Default is env_var.
    description String
    The description of the variable. Maximum of 255 characters.
    key String
    The name of the variable.
    masked Boolean
    If set to true, the value of the variable will be hidden in job logs. The value must meet the masking requirements. Defaults to false.
    protected_ Boolean
    If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.
    raw Boolean
    Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
    value String
    The value of the variable.
    variableType String
    The type of a variable. Valid values are: env_var, file. Default is env_var.
    description string
    The description of the variable. Maximum of 255 characters.
    key string
    The name of the variable.
    masked boolean
    If set to true, the value of the variable will be hidden in job logs. The value must meet the masking requirements. Defaults to false.
    protected boolean
    If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.
    raw boolean
    Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
    value string
    The value of the variable.
    variableType string
    The type of a variable. Valid values are: env_var, file. Default is env_var.
    description str
    The description of the variable. Maximum of 255 characters.
    key str
    The name of the variable.
    masked bool
    If set to true, the value of the variable will be hidden in job logs. The value must meet the masking requirements. Defaults to false.
    protected bool
    If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.
    raw bool
    Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
    value str
    The value of the variable.
    variable_type str
    The type of a variable. Valid values are: env_var, file. Default is env_var.
    description String
    The description of the variable. Maximum of 255 characters.
    key String
    The name of the variable.
    masked Boolean
    If set to true, the value of the variable will be hidden in job logs. The value must meet the masking requirements. Defaults to false.
    protected Boolean
    If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.
    raw Boolean
    Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
    value String
    The value of the variable.
    variableType String
    The type of a variable. Valid values are: env_var, file. Default is env_var.

    Package Details

    Repository
    GitLab pulumi/pulumi-gitlab
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the gitlab Terraform Provider.
    gitlab logo
    GitLab v8.11.0 published on Friday, Apr 18, 2025 by Pulumi
    pulumi/pulumi-gitlab