GroupVariable

class GroupVariable : KotlinCustomResource

The gitlab.GroupVariable resource allows to manage the lifecycle of a CI/CD variable for a group. Upstream API: GitLab REST API docs

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";
const example = new gitlab.GroupVariable("example", {
environmentScope: "*",
group: "12345",
key: "group_variable_key",
masked: false,
"protected": false,
value: "group_variable_value",
});
import pulumi
import pulumi_gitlab as gitlab
example = gitlab.GroupVariable("example",
environment_scope="*",
group="12345",
key="group_variable_key",
masked=False,
protected=False,
value="group_variable_value")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;
return await Deployment.RunAsync(() =>
{
var example = new GitLab.GroupVariable("example", new()
{
EnvironmentScope = "*",
Group = "12345",
Key = "group_variable_key",
Masked = false,
Protected = false,
Value = "group_variable_value",
});
});
package main
import (
"github.com/pulumi/pulumi-gitlab/sdk/v6/go/gitlab"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := gitlab.NewGroupVariable(ctx, "example", &gitlab.GroupVariableArgs{
EnvironmentScope: pulumi.String("*"),
Group: pulumi.String("12345"),
Key: pulumi.String("group_variable_key"),
Masked: pulumi.Bool(false),
Protected: pulumi.Bool(false),
Value: pulumi.String("group_variable_value"),
})
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.GroupVariable;
import com.pulumi.gitlab.GroupVariableArgs;
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 GroupVariable("example", GroupVariableArgs.builder()
.environmentScope("*")
.group("12345")
.key("group_variable_key")
.masked(false)
.protected_(false)
.value("group_variable_value")
.build());
}
}
resources:
example:
type: gitlab:GroupVariable
properties:
environmentScope: '*'
group: '12345'
key: group_variable_key
masked: false
protected: false
value: group_variable_value

Import

GitLab group variables can be imported using an id made up of groupid:variablename:scope, e.g.

$ pulumi import gitlab:index/groupVariable:GroupVariable example 12345:group_variable_key:*

Properties

Link copied to clipboard
val description: Output<String>?

The description of the variable.

Link copied to clipboard
val environmentScope: Output<String>?

The environment scope of the variable. Defaults to all environment (*). Note that in Community Editions of Gitlab, values other than * will cause inconsistent plans.

Link copied to clipboard
val group: Output<String>

The name or id of the group.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val key: Output<String>

The name of the variable.

Link copied to clipboard
val masked: Output<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.

Link copied to clipboard
val protected: Output<Boolean>?

If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val raw: Output<Boolean>?

Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val value: Output<String>

The value of the variable.

Link copied to clipboard
val variableType: Output<String>?

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