pulumi-gitlab-kotlin/com.pulumi.gitlab.kotlin/GroupAccessToken

GroupAccessToken

class GroupAccessToken : KotlinCustomResource

The gitlab.GroupAccessTokenresource allows to manage the lifecycle of a group access token.

Observability scopes are in beta and may not work on all instances. See more details in the documentation Use rotation_configuration to automatically rotate tokens instead of using timestamp() as timestamp will cause changes with every plan. pulumi up must still be run to rotate the token. Due to Automatic reuse detection it's possible that a new Group Access Token will immediately be revoked. Check if an old process using the old token is running if this happens. Upstream API: GitLab REST API

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";
const example = new gitlab.GroupAccessToken("example", {
    group: "25",
    name: "Example project access token",
    expiresAt: "2020-03-14",
    accessLevel: "developer",
    scopes: ["api"],
});
const exampleGroupVariable = new gitlab.GroupVariable("example", {
    group: "25",
    key: "gat",
    value: example.token,
});

import pulumi
import pulumi_gitlab as gitlab
example = gitlab.GroupAccessToken("example",
    group="25",
    name="Example project access token",
    expires_at="2020-03-14",
    access_level="developer",
    scopes=["api"])
example_group_variable = gitlab.GroupVariable("example",
    group="25",
    key="gat",
    value=example.token)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;
return await Deployment.RunAsync(() =>
{
    var example = new GitLab.GroupAccessToken("example", new()
    {
        Group = "25",
        Name = "Example project access token",
        ExpiresAt = "2020-03-14",
        AccessLevel = "developer",
        Scopes = new[]
        {
            "api",
        },
    });
    var exampleGroupVariable = new GitLab.GroupVariable("example", new()
    {
        Group = "25",
        Key = "gat",
        Value = example.Token,
    });
});

package main
import (
	"github.com/pulumi/pulumi-gitlab/sdk/v7/go/gitlab"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := gitlab.NewGroupAccessToken(ctx, "example", &gitlab.GroupAccessTokenArgs{
			Group:       pulumi.String("25"),
			Name:        pulumi.String("Example project access token"),
			ExpiresAt:   pulumi.String("2020-03-14"),
			AccessLevel: pulumi.String("developer"),
			Scopes: pulumi.StringArray{
				pulumi.String("api"),
			},
		})
		if err != nil {
			return err
		}
		_, err = gitlab.NewGroupVariable(ctx, "example", &gitlab.GroupVariableArgs{
			Group: pulumi.String("25"),
			Key:   pulumi.String("gat"),
			Value: example.Token,
		})
		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.GroupAccessToken;
import com.pulumi.gitlab.GroupAccessTokenArgs;
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 GroupAccessToken("example", GroupAccessTokenArgs.builder()
            .group("25")
            .name("Example project access token")
            .expiresAt("2020-03-14")
            .accessLevel("developer")
            .scopes("api")
            .build());
        var exampleGroupVariable = new GroupVariable("exampleGroupVariable", GroupVariableArgs.builder()
            .group("25")
            .key("gat")
            .value(example.token())
            .build());
    }
}

resources:
  example:
    type: gitlab:GroupAccessToken
    properties:
      group: '25'
      name: Example project access token
      expiresAt: 2020-03-14
      accessLevel: developer
      scopes:
        - api
  exampleGroupVariable:
    type: gitlab:GroupVariable
    name: example
    properties:
      group: '25'
      key: gat
      value: ${example.token}

Import

A GitLab Group Access Token can be imported using a key composed of <group-id>:<token-id>, e.g.

$ pulumi import gitlab:index/groupAccessToken:GroupAccessToken example "12345:1"

ATTENTION: the token resource attribute is not available for imported resources as this information cannot be read from the GitLab API.

Properties

accessLevel

val accessLevel: Output<String>

The access level for the group access token. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner, master. Default is maintainer.

active

val active: Output<Boolean>

True if the token is active.

createdAt

val createdAt: Output<String>

Time the token has been created, RFC3339 format.

expiresAt

val expiresAt: Output<String>

When the token will expire, YYYY-MM-DD format.

group

val group: Output<String>

The ID or full path of the group.

val id: Output<String>

name

val name: Output<String>

The name of the group access token.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

revoked

val revoked: Output<Boolean>

True if the token is revoked.

rotationConfiguration

val rotationConfiguration: Output<GroupAccessTokenRotationConfiguration>?

The configuration for when to rotate a token automatically. Will not rotate a token until pulumi up is run.

scopes

val scopes: Output<List<String>>

The scopes of the group access token. Valid values are: api, read_api, read_user, k8s_proxy, read_registry, write_registry, read_repository, write_repository, create_runner, ai_features, k8s_proxy, read_observability, write_observability

token

val token: Output<String>

The token of the group access token. Note: the token is not available for imported resources.

urn

val urn: Output<String>

userId

val userId: Output<Int>

The user_id associated to the token.