Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gitlab Provider
  3. API Docs
  4. InstanceVariable
GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab

gitlab.InstanceVariable

Explore with Pulumi AI

GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab

The gitlab.InstanceVariable resource allows to manage the lifecycle of an instance-level CI/CD variable.

Upstream API: GitLab REST API docs

Example Usage

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

const example = new gitlab.InstanceVariable("example", {
    key: "instance_variable_key",
    value: "instance_variable_value",
    "protected": false,
    masked: false,
});
Copy
import pulumi
import pulumi_gitlab as gitlab

example = gitlab.InstanceVariable("example",
    key="instance_variable_key",
    value="instance_variable_value",
    protected=False,
    masked=False)
Copy
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.NewInstanceVariable(ctx, "example", &gitlab.InstanceVariableArgs{
			Key:       pulumi.String("instance_variable_key"),
			Value:     pulumi.String("instance_variable_value"),
			Protected: pulumi.Bool(false),
			Masked:    pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;

return await Deployment.RunAsync(() => 
{
    var example = new GitLab.InstanceVariable("example", new()
    {
        Key = "instance_variable_key",
        Value = "instance_variable_value",
        Protected = false,
        Masked = false,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.InstanceVariable;
import com.pulumi.gitlab.InstanceVariableArgs;
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 example = new InstanceVariable("example", InstanceVariableArgs.builder()
            .key("instance_variable_key")
            .value("instance_variable_value")
            .protected_(false)
            .masked(false)
            .build());

    }
}
Copy
resources:
  example:
    type: gitlab:InstanceVariable
    properties:
      key: instance_variable_key
      value: instance_variable_value
      protected: false
      masked: false
Copy

Create InstanceVariable Resource

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

Constructor syntax

new InstanceVariable(name: string, args: InstanceVariableArgs, opts?: CustomResourceOptions);
@overload
def InstanceVariable(resource_name: str,
                     args: InstanceVariableArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def InstanceVariable(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     key: Optional[str] = None,
                     value: Optional[str] = None,
                     description: Optional[str] = None,
                     masked: Optional[bool] = None,
                     protected: Optional[bool] = None,
                     raw: Optional[bool] = None,
                     variable_type: Optional[str] = None)
func NewInstanceVariable(ctx *Context, name string, args InstanceVariableArgs, opts ...ResourceOption) (*InstanceVariable, error)
public InstanceVariable(string name, InstanceVariableArgs args, CustomResourceOptions? opts = null)
public InstanceVariable(String name, InstanceVariableArgs args)
public InstanceVariable(String name, InstanceVariableArgs args, CustomResourceOptions options)

type: gitlab:InstanceVariable
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. InstanceVariableArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. InstanceVariableArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. InstanceVariableArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. InstanceVariableArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. InstanceVariableArgs
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 instanceVariableResource = new GitLab.InstanceVariable("instanceVariableResource", new()
{
    Key = "string",
    Value = "string",
    Description = "string",
    Masked = false,
    Protected = false,
    Raw = false,
    VariableType = "string",
});
Copy
example, err := gitlab.NewInstanceVariable(ctx, "instanceVariableResource", &gitlab.InstanceVariableArgs{
	Key:          pulumi.String("string"),
	Value:        pulumi.String("string"),
	Description:  pulumi.String("string"),
	Masked:       pulumi.Bool(false),
	Protected:    pulumi.Bool(false),
	Raw:          pulumi.Bool(false),
	VariableType: pulumi.String("string"),
})
Copy
var instanceVariableResource = new InstanceVariable("instanceVariableResource", InstanceVariableArgs.builder()
    .key("string")
    .value("string")
    .description("string")
    .masked(false)
    .protected_(false)
    .raw(false)
    .variableType("string")
    .build());
Copy
instance_variable_resource = gitlab.InstanceVariable("instanceVariableResource",
    key="string",
    value="string",
    description="string",
    masked=False,
    protected=False,
    raw=False,
    variable_type="string")
Copy
const instanceVariableResource = new gitlab.InstanceVariable("instanceVariableResource", {
    key: "string",
    value: "string",
    description: "string",
    masked: false,
    "protected": false,
    raw: false,
    variableType: "string",
});
Copy
type: gitlab:InstanceVariable
properties:
    description: string
    key: string
    masked: false
    protected: false
    raw: false
    value: string
    variableType: string
Copy

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

Key
This property is required.
Changes to this property will trigger replacement.
string
The name of the variable.
Value This property is required. string
The value of the variable.
Description string
The description of the variable. Maximum of 255 characters.
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.
VariableType string
The type of a variable. Valid values are: env_var, file. Default is env_var.
Key
This property is required.
Changes to this property will trigger replacement.
string
The name of the variable.
Value This property is required. string
The value of the variable.
Description string
The description of the variable. Maximum of 255 characters.
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.
VariableType string
The type of a variable. Valid values are: env_var, file. Default is env_var.
key
This property is required.
Changes to this property will trigger replacement.
String
The name of the variable.
value This property is required. String
The value of the variable.
description String
The description of the variable. Maximum of 255 characters.
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.
variableType String
The type of a variable. Valid values are: env_var, file. Default is env_var.
key
This property is required.
Changes to this property will trigger replacement.
string
The name of the variable.
value This property is required. string
The value of the variable.
description string
The description of the variable. Maximum of 255 characters.
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.
variableType string
The type of a variable. Valid values are: env_var, file. Default is env_var.
key
This property is required.
Changes to this property will trigger replacement.
str
The name of the variable.
value This property is required. str
The value of the variable.
description str
The description of the variable. Maximum of 255 characters.
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.
variable_type str
The type of a variable. Valid values are: env_var, file. Default is env_var.
key
This property is required.
Changes to this property will trigger replacement.
String
The name of the variable.
value This property is required. String
The value of the variable.
description String
The description of the variable. Maximum of 255 characters.
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.
variableType String
The type of a variable. Valid values are: env_var, file. Default is env_var.

Outputs

All input properties are implicitly available as output properties. Additionally, the InstanceVariable 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 InstanceVariable Resource

Get an existing InstanceVariable 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?: InstanceVariableState, opts?: CustomResourceOptions): InstanceVariable
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        key: Optional[str] = None,
        masked: Optional[bool] = None,
        protected: Optional[bool] = None,
        raw: Optional[bool] = None,
        value: Optional[str] = None,
        variable_type: Optional[str] = None) -> InstanceVariable
func GetInstanceVariable(ctx *Context, name string, id IDInput, state *InstanceVariableState, opts ...ResourceOption) (*InstanceVariable, error)
public static InstanceVariable Get(string name, Input<string> id, InstanceVariableState? state, CustomResourceOptions? opts = null)
public static InstanceVariable get(String name, Output<String> id, InstanceVariableState state, CustomResourceOptions options)
resources:  _:    type: gitlab:InstanceVariable    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description string
The description of the variable. Maximum of 255 characters.
Key Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.

Import

Starting in Terraform v1.5.0 you can use an import block to import gitlab_instance_variable. For example:

terraform

import {

to = gitlab_instance_variable.example

id = “see CLI command below for ID”

}

Import using the CLI is supported using the following syntax:

GitLab instance variables can be imported using an id made up of variablename, e.g.

$ pulumi import gitlab:index/instanceVariable:InstanceVariable example instance_variable_key
Copy

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

Package Details

Repository
GitLab pulumi/pulumi-gitlab
License
Apache-2.0
Notes
This Pulumi package is based on the gitlab Terraform Provider.
GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab