GroupVariable

# gitlab_group_variable

This resource allows you to create and manage CI/CD variables for your GitLab groups. For further information on variables, consult the gitlab documentation.

Example Usage

using Pulumi;
using GitLab = Pulumi.GitLab;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new GitLab.GroupVariable("example", new GitLab.GroupVariableArgs
        {
            Group = "12345",
            Key = "group_variable_key",
            Masked = false,
            Protected = false,
            Value = "group_variable_value",
        });
    }

}
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.NewGroupVariable(ctx, "example", &gitlab.GroupVariableArgs{
			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
	})
}
import pulumi
import pulumi_gitlab as gitlab

example = gitlab.GroupVariable("example",
    group="12345",
    key="group_variable_key",
    masked=False,
    protected=False,
    value="group_variable_value")
import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const example = new gitlab.GroupVariable("example", {
    group: "12345",
    key: "group_variable_key",
    masked: false,
    protected: false,
    value: "group_variable_value",
});

Create a GroupVariable Resource

new GroupVariable(name: string, args: GroupVariableArgs, opts?: CustomResourceOptions);
@overload
def GroupVariable(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  group: Optional[str] = None,
                  key: Optional[str] = None,
                  masked: Optional[bool] = None,
                  protected: Optional[bool] = None,
                  value: Optional[str] = None,
                  variable_type: Optional[str] = None)
@overload
def GroupVariable(resource_name: str,
                  args: GroupVariableArgs,
                  opts: Optional[ResourceOptions] = None)
func NewGroupVariable(ctx *Context, name string, args GroupVariableArgs, opts ...ResourceOption) (*GroupVariable, error)
public GroupVariable(string name, GroupVariableArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args GroupVariableArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args GroupVariableArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args GroupVariableArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GroupVariableArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

GroupVariable Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The GroupVariable resource accepts the following input properties:

Group string
The name or id of the group to add the hook to.
Key string
The name of the variable.
Value string
The value of the variable.
Masked bool
Protected bool
If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.
VariableType string
The type of a variable. Available types are: env_var (default) and file.
Group string
The name or id of the group to add the hook to.
Key string
The name of the variable.
Value string
The value of the variable.
Masked bool
Protected bool
If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.
VariableType string
The type of a variable. Available types are: env_var (default) and file.
group string
The name or id of the group to add the hook to.
key string
The name of the variable.
value string
The value of the variable.
masked boolean
protected boolean
If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.
variableType string
The type of a variable. Available types are: env_var (default) and file.
group str
The name or id of the group to add the hook to.
key str
The name of the variable.
value str
The value of the variable.
masked bool
protected bool
If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.
variable_type str
The type of a variable. Available types are: env_var (default) and file.

Outputs

All input properties are implicitly available as output properties. Additionally, the GroupVariable 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 str
The provider-assigned unique ID for this managed resource.

Look up an Existing GroupVariable Resource

Get an existing GroupVariable 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?: GroupVariableState, opts?: CustomResourceOptions): GroupVariable
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        group: Optional[str] = None,
        key: Optional[str] = None,
        masked: Optional[bool] = None,
        protected: Optional[bool] = None,
        value: Optional[str] = None,
        variable_type: Optional[str] = None) -> GroupVariable
func GetGroupVariable(ctx *Context, name string, id IDInput, state *GroupVariableState, opts ...ResourceOption) (*GroupVariable, error)
public static GroupVariable Get(string name, Input<string> id, GroupVariableState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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:

Group string
The name or id of the group to add the hook to.
Key string
The name of the variable.
Masked bool
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. Available types are: env_var (default) and file.
Group string
The name or id of the group to add the hook to.
Key string
The name of the variable.
Masked bool
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. Available types are: env_var (default) and file.
group string
The name or id of the group to add the hook to.
key string
The name of the variable.
masked boolean
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. Available types are: env_var (default) and file.
group str
The name or id of the group to add the hook to.
key str
The name of the variable.
masked bool
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. Available types are: env_var (default) and file.

Import

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

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

Package Details

Repository
https://github.com/pulumi/pulumi-gitlab
License
Apache-2.0
Notes
This Pulumi package is based on the gitlab Terraform Provider.