gitlab logo
GitLab v4.9.0, Oct 24 22

gitlab.getInstanceVariable

The gitlab.InstanceVariable data source allows to retrieve details about an instance-level CI/CD variable.

Upstream API: GitLab REST API docs

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var foo = GitLab.GetInstanceVariable.Invoke(new()
    {
        Key = "foo",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err = gitlab.LookupInstanceVariable(ctx, &GetInstanceVariableArgs{
			Key: "foo",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.GitlabFunctions;
import com.pulumi.gitlab.inputs.GetInstanceVariableArgs;
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 foo = GitlabFunctions.getInstanceVariable(GetInstanceVariableArgs.builder()
            .key("foo")
            .build());

    }
}
import pulumi
import pulumi_gitlab as gitlab

foo = gitlab.get_instance_variable(key="foo")
import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const foo = pulumi.output(gitlab.getInstanceVariable({
    key: "foo",
}));
variables:
  foo:
    fn::invoke:
      Function: gitlab:getInstanceVariable
      Arguments:
        key: foo

Using getInstanceVariable

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 getInstanceVariable(args: GetInstanceVariableArgs, opts?: InvokeOptions): Promise<GetInstanceVariableResult>
function getInstanceVariableOutput(args: GetInstanceVariableOutputArgs, opts?: InvokeOptions): Output<GetInstanceVariableResult>
def get_instance_variable(key: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetInstanceVariableResult
def get_instance_variable_output(key: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetInstanceVariableResult]
func LookupInstanceVariable(ctx *Context, args *LookupInstanceVariableArgs, opts ...InvokeOption) (*LookupInstanceVariableResult, error)
func LookupInstanceVariableOutput(ctx *Context, args *LookupInstanceVariableOutputArgs, opts ...InvokeOption) LookupInstanceVariableResultOutput

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

public static class GetInstanceVariable 
{
    public static Task<GetInstanceVariableResult> InvokeAsync(GetInstanceVariableArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceVariableResult> Invoke(GetInstanceVariableInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetInstanceVariableResult> getInstanceVariable(GetInstanceVariableArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: gitlab:index/getInstanceVariable:getInstanceVariable
  arguments:
    # arguments dictionary

The following arguments are supported:

Key string

The name of the variable.

Key string

The name of the variable.

key String

The name of the variable.

key string

The name of the variable.

key str

The name of the variable.

key String

The name of the variable.

getInstanceVariable Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

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.

Value string

The value of the variable.

VariableType string

The type of a variable. Valid values are: env_var, file. Default is env_var.

Id string

The provider-assigned unique ID for this managed resource.

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.

Value string

The value of the variable.

VariableType string

The type of a variable. Valid values are: env_var, file. Default is env_var.

id String

The provider-assigned unique ID for this managed resource.

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.

value String

The value of the variable.

variableType String

The type of a variable. Valid values are: env_var, file. Default is env_var.

id string

The provider-assigned unique ID for this managed resource.

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.

value string

The value of the variable.

variableType string

The type of a variable. Valid values are: env_var, file. Default is env_var.

id str

The provider-assigned unique ID for this managed resource.

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.

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.

id String

The provider-assigned unique ID for this managed resource.

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.

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.