1. Packages
  2. Packages
  3. Gitlab Provider
  4. API Docs
  5. RunnerControllerToken
Viewing docs for GitLab v9.11.0
published on Tuesday, Apr 21, 2026 by Pulumi
gitlab logo
Viewing docs for GitLab v9.11.0
published on Tuesday, Apr 21, 2026 by Pulumi

    The gitlab.RunnerControllerToken resource manages the lifecycle of a runner controller token.

    This resource is experimental and may change or be removed in future versions. Introduced in GitLab 18.9.

    This resource requires administration privileges.

    Upstream API: GitLab REST API docs

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as gitlab from "@pulumi/gitlab";
    
    const example = new gitlab.RunnerControllerToken("example", {
        runnerControllerId: exampleGitlabRunnerController.id,
        description: "My controller token",
    });
    
    import pulumi
    import pulumi_gitlab as gitlab
    
    example = gitlab.RunnerControllerToken("example",
        runner_controller_id=example_gitlab_runner_controller["id"],
        description="My controller token")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gitlab/sdk/v9/go/gitlab"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := gitlab.NewRunnerControllerToken(ctx, "example", &gitlab.RunnerControllerTokenArgs{
    			RunnerControllerId: pulumi.Any(exampleGitlabRunnerController.Id),
    			Description:        pulumi.String("My controller token"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using GitLab = Pulumi.GitLab;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new GitLab.Index.RunnerControllerToken("example", new()
        {
            RunnerControllerId = exampleGitlabRunnerController.Id,
            Description = "My controller token",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gitlab.RunnerControllerToken;
    import com.pulumi.gitlab.RunnerControllerTokenArgs;
    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 RunnerControllerToken("example", RunnerControllerTokenArgs.builder()
                .runnerControllerId(exampleGitlabRunnerController.id())
                .description("My controller token")
                .build());
    
        }
    }
    
    resources:
      example:
        type: gitlab:RunnerControllerToken
        properties:
          runnerControllerId: ${exampleGitlabRunnerController.id}
          description: My controller token
    

    Create RunnerControllerToken Resource

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

    Constructor syntax

    new RunnerControllerToken(name: string, args: RunnerControllerTokenArgs, opts?: CustomResourceOptions);
    @overload
    def RunnerControllerToken(resource_name: str,
                              args: RunnerControllerTokenArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def RunnerControllerToken(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              runner_controller_id: Optional[int] = None,
                              description: Optional[str] = None)
    func NewRunnerControllerToken(ctx *Context, name string, args RunnerControllerTokenArgs, opts ...ResourceOption) (*RunnerControllerToken, error)
    public RunnerControllerToken(string name, RunnerControllerTokenArgs args, CustomResourceOptions? opts = null)
    public RunnerControllerToken(String name, RunnerControllerTokenArgs args)
    public RunnerControllerToken(String name, RunnerControllerTokenArgs args, CustomResourceOptions options)
    
    type: gitlab:RunnerControllerToken
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args RunnerControllerTokenArgs
    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 RunnerControllerTokenArgs
    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 RunnerControllerTokenArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RunnerControllerTokenArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RunnerControllerTokenArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    RunnerControllerId int
    The ID of the runner controller.
    Description string
    The description of the runner controller token.
    RunnerControllerId int
    The ID of the runner controller.
    Description string
    The description of the runner controller token.
    runnerControllerId Integer
    The ID of the runner controller.
    description String
    The description of the runner controller token.
    runnerControllerId number
    The ID of the runner controller.
    description string
    The description of the runner controller token.
    runner_controller_id int
    The ID of the runner controller.
    description str
    The description of the runner controller token.
    runnerControllerId Number
    The ID of the runner controller.
    description String
    The description of the runner controller token.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RunnerControllerToken resource produces the following output properties:

    CreatedAt string
    The time the token was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The token value. Note: the token is not available for imported resources.
    UpdatedAt string
    The time the token was last updated.
    CreatedAt string
    The time the token was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The token value. Note: the token is not available for imported resources.
    UpdatedAt string
    The time the token was last updated.
    createdAt String
    The time the token was created.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The token value. Note: the token is not available for imported resources.
    updatedAt String
    The time the token was last updated.
    createdAt string
    The time the token was created.
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    The token value. Note: the token is not available for imported resources.
    updatedAt string
    The time the token was last updated.
    created_at str
    The time the token was created.
    id str
    The provider-assigned unique ID for this managed resource.
    token str
    The token value. Note: the token is not available for imported resources.
    updated_at str
    The time the token was last updated.
    createdAt String
    The time the token was created.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The token value. Note: the token is not available for imported resources.
    updatedAt String
    The time the token was last updated.

    Look up Existing RunnerControllerToken Resource

    Get an existing RunnerControllerToken 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?: RunnerControllerTokenState, opts?: CustomResourceOptions): RunnerControllerToken
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created_at: Optional[str] = None,
            description: Optional[str] = None,
            runner_controller_id: Optional[int] = None,
            token: Optional[str] = None,
            updated_at: Optional[str] = None) -> RunnerControllerToken
    func GetRunnerControllerToken(ctx *Context, name string, id IDInput, state *RunnerControllerTokenState, opts ...ResourceOption) (*RunnerControllerToken, error)
    public static RunnerControllerToken Get(string name, Input<string> id, RunnerControllerTokenState? state, CustomResourceOptions? opts = null)
    public static RunnerControllerToken get(String name, Output<String> id, RunnerControllerTokenState state, CustomResourceOptions options)
    resources:  _:    type: gitlab:RunnerControllerToken    get:      id: ${id}
    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.
    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:
    CreatedAt string
    The time the token was created.
    Description string
    The description of the runner controller token.
    RunnerControllerId int
    The ID of the runner controller.
    Token string
    The token value. Note: the token is not available for imported resources.
    UpdatedAt string
    The time the token was last updated.
    CreatedAt string
    The time the token was created.
    Description string
    The description of the runner controller token.
    RunnerControllerId int
    The ID of the runner controller.
    Token string
    The token value. Note: the token is not available for imported resources.
    UpdatedAt string
    The time the token was last updated.
    createdAt String
    The time the token was created.
    description String
    The description of the runner controller token.
    runnerControllerId Integer
    The ID of the runner controller.
    token String
    The token value. Note: the token is not available for imported resources.
    updatedAt String
    The time the token was last updated.
    createdAt string
    The time the token was created.
    description string
    The description of the runner controller token.
    runnerControllerId number
    The ID of the runner controller.
    token string
    The token value. Note: the token is not available for imported resources.
    updatedAt string
    The time the token was last updated.
    created_at str
    The time the token was created.
    description str
    The description of the runner controller token.
    runner_controller_id int
    The ID of the runner controller.
    token str
    The token value. Note: the token is not available for imported resources.
    updated_at str
    The time the token was last updated.
    createdAt String
    The time the token was created.
    description String
    The description of the runner controller token.
    runnerControllerId Number
    The ID of the runner controller.
    token String
    The token value. Note: the token is not available for imported resources.
    updatedAt String
    The time the token was last updated.

    Package Details

    Repository
    GitLab pulumi/pulumi-gitlab
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the gitlab Terraform Provider.
    gitlab logo
    Viewing docs for GitLab v9.11.0
    published on Tuesday, Apr 21, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.