pulumi-gitlab-kotlin/com.pulumi.gitlab.kotlin/ProjectAccessToken

ProjectAccessToken

class ProjectAccessToken : KotlinCustomResource

The gitlab.ProjectAccessToken resource allows to manage the lifecycle of a project 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 Project Access Token will immediately be revoked. Check if an old process using the old token is running if this happens. Upstream API: GitLab API docs

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";
const example = new gitlab.ProjectAccessToken("example", {
    project: "25",
    name: "Example project access token",
    expiresAt: "2020-03-14",
    accessLevel: "reporter",
    scopes: ["api"],
});
const exampleProjectVariable = new gitlab.ProjectVariable("example", {
    project: exampleGitlabProject.id,
    key: "pat",
    value: example.token,
});

import pulumi
import pulumi_gitlab as gitlab
example = gitlab.ProjectAccessToken("example",
    project="25",
    name="Example project access token",
    expires_at="2020-03-14",
    access_level="reporter",
    scopes=["api"])
example_project_variable = gitlab.ProjectVariable("example",
    project=example_gitlab_project["id"],
    key="pat",
    value=example.token)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;
return await Deployment.RunAsync(() =>
{
    var example = new GitLab.ProjectAccessToken("example", new()
    {
        Project = "25",
        Name = "Example project access token",
        ExpiresAt = "2020-03-14",
        AccessLevel = "reporter",
        Scopes = new[]
        {
            "api",
        },
    });
    var exampleProjectVariable = new GitLab.ProjectVariable("example", new()
    {
        Project = exampleGitlabProject.Id,
        Key = "pat",
        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.NewProjectAccessToken(ctx, "example", &gitlab.ProjectAccessTokenArgs{
			Project:     pulumi.String("25"),
			Name:        pulumi.String("Example project access token"),
			ExpiresAt:   pulumi.String("2020-03-14"),
			AccessLevel: pulumi.String("reporter"),
			Scopes: pulumi.StringArray{
				pulumi.String("api"),
			},
		})
		if err != nil {
			return err
		}
		_, err = gitlab.NewProjectVariable(ctx, "example", &gitlab.ProjectVariableArgs{
			Project: pulumi.Any(exampleGitlabProject.Id),
			Key:     pulumi.String("pat"),
			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.ProjectAccessToken;
import com.pulumi.gitlab.ProjectAccessTokenArgs;
import com.pulumi.gitlab.ProjectVariable;
import com.pulumi.gitlab.ProjectVariableArgs;
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 ProjectAccessToken("example", ProjectAccessTokenArgs.builder()
            .project("25")
            .name("Example project access token")
            .expiresAt("2020-03-14")
            .accessLevel("reporter")
            .scopes("api")
            .build());
        var exampleProjectVariable = new ProjectVariable("exampleProjectVariable", ProjectVariableArgs.builder()
            .project(exampleGitlabProject.id())
            .key("pat")
            .value(example.token())
            .build());
    }
}

resources:
  example:
    type: gitlab:ProjectAccessToken
    properties:
      project: '25'
      name: Example project access token
      expiresAt: 2020-03-14
      accessLevel: reporter
      scopes:
        - api
  exampleProjectVariable:
    type: gitlab:ProjectVariable
    name: example
    properties:
      project: ${exampleGitlabProject.id}
      key: pat
      value: ${example.token}

Import

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

$ pulumi import gitlab:index/projectAccessToken:ProjectAccessToken example "12345:1"

NOTE: 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 project 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. Is automatically set when rotation_configuration is used.

val id: Output<String>

name

val name: Output<String>

The name of the project access token.

project

val project: Output<String>

The ID or full path of the project.

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<ProjectAccessTokenRotationConfiguration>?

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 project 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 project 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.