1. Packages
  2. Packages
  3. Gitlab Provider
  4. API Docs
  5. RunnerControllerRunnerScope
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.RunnerControllerRunnerScope resource manages a runner-level scope of a runner controller. The runner must be an instance-level runner.

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

    This resource requires administration privileges.

    Instance scopes and runner scopes are mutually exclusive on a runner controller.

    Upstream API: GitLab REST API docs

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as gitlab from "@pulumi/gitlab";
    
    const example = new gitlab.RunnerControllerRunnerScope("example", {
        runnerControllerId: exampleGitlabRunnerController.id,
        runnerId: 42,
    });
    
    import pulumi
    import pulumi_gitlab as gitlab
    
    example = gitlab.RunnerControllerRunnerScope("example",
        runner_controller_id=example_gitlab_runner_controller["id"],
        runner_id=42)
    
    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.NewRunnerControllerRunnerScope(ctx, "example", &gitlab.RunnerControllerRunnerScopeArgs{
    			RunnerControllerId: pulumi.Any(exampleGitlabRunnerController.Id),
    			RunnerId:           pulumi.Int(42),
    		})
    		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.RunnerControllerRunnerScope("example", new()
        {
            RunnerControllerId = exampleGitlabRunnerController.Id,
            RunnerId = 42,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gitlab.RunnerControllerRunnerScope;
    import com.pulumi.gitlab.RunnerControllerRunnerScopeArgs;
    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 RunnerControllerRunnerScope("example", RunnerControllerRunnerScopeArgs.builder()
                .runnerControllerId(exampleGitlabRunnerController.id())
                .runnerId(42)
                .build());
    
        }
    }
    
    resources:
      example:
        type: gitlab:RunnerControllerRunnerScope
        properties:
          runnerControllerId: ${exampleGitlabRunnerController.id}
          runnerId: 42
    

    Create RunnerControllerRunnerScope Resource

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

    Constructor syntax

    new RunnerControllerRunnerScope(name: string, args: RunnerControllerRunnerScopeArgs, opts?: CustomResourceOptions);
    @overload
    def RunnerControllerRunnerScope(resource_name: str,
                                    args: RunnerControllerRunnerScopeArgs,
                                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def RunnerControllerRunnerScope(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    runner_controller_id: Optional[int] = None,
                                    runner_id: Optional[int] = None)
    func NewRunnerControllerRunnerScope(ctx *Context, name string, args RunnerControllerRunnerScopeArgs, opts ...ResourceOption) (*RunnerControllerRunnerScope, error)
    public RunnerControllerRunnerScope(string name, RunnerControllerRunnerScopeArgs args, CustomResourceOptions? opts = null)
    public RunnerControllerRunnerScope(String name, RunnerControllerRunnerScopeArgs args)
    public RunnerControllerRunnerScope(String name, RunnerControllerRunnerScopeArgs args, CustomResourceOptions options)
    
    type: gitlab:RunnerControllerRunnerScope
    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 RunnerControllerRunnerScopeArgs
    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 RunnerControllerRunnerScopeArgs
    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 RunnerControllerRunnerScopeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RunnerControllerRunnerScopeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RunnerControllerRunnerScopeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    RunnerControllerId int
    The ID of the runner controller.
    RunnerId int
    The ID of the instance-level runner to scope the controller to.
    RunnerControllerId int
    The ID of the runner controller.
    RunnerId int
    The ID of the instance-level runner to scope the controller to.
    runnerControllerId Integer
    The ID of the runner controller.
    runnerId Integer
    The ID of the instance-level runner to scope the controller to.
    runnerControllerId number
    The ID of the runner controller.
    runnerId number
    The ID of the instance-level runner to scope the controller to.
    runner_controller_id int
    The ID of the runner controller.
    runner_id int
    The ID of the instance-level runner to scope the controller to.
    runnerControllerId Number
    The ID of the runner controller.
    runnerId Number
    The ID of the instance-level runner to scope the controller to.

    Outputs

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

    CreatedAt string
    The time the scope was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The time the scope was last updated.
    CreatedAt string
    The time the scope was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The time the scope was last updated.
    createdAt String
    The time the scope was created.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The time the scope was last updated.
    createdAt string
    The time the scope was created.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    The time the scope was last updated.
    created_at str
    The time the scope was created.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    The time the scope was last updated.
    createdAt String
    The time the scope was created.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The time the scope was last updated.

    Look up Existing RunnerControllerRunnerScope Resource

    Get an existing RunnerControllerRunnerScope 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?: RunnerControllerRunnerScopeState, opts?: CustomResourceOptions): RunnerControllerRunnerScope
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created_at: Optional[str] = None,
            runner_controller_id: Optional[int] = None,
            runner_id: Optional[int] = None,
            updated_at: Optional[str] = None) -> RunnerControllerRunnerScope
    func GetRunnerControllerRunnerScope(ctx *Context, name string, id IDInput, state *RunnerControllerRunnerScopeState, opts ...ResourceOption) (*RunnerControllerRunnerScope, error)
    public static RunnerControllerRunnerScope Get(string name, Input<string> id, RunnerControllerRunnerScopeState? state, CustomResourceOptions? opts = null)
    public static RunnerControllerRunnerScope get(String name, Output<String> id, RunnerControllerRunnerScopeState state, CustomResourceOptions options)
    resources:  _:    type: gitlab:RunnerControllerRunnerScope    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 scope was created.
    RunnerControllerId int
    The ID of the runner controller.
    RunnerId int
    The ID of the instance-level runner to scope the controller to.
    UpdatedAt string
    The time the scope was last updated.
    CreatedAt string
    The time the scope was created.
    RunnerControllerId int
    The ID of the runner controller.
    RunnerId int
    The ID of the instance-level runner to scope the controller to.
    UpdatedAt string
    The time the scope was last updated.
    createdAt String
    The time the scope was created.
    runnerControllerId Integer
    The ID of the runner controller.
    runnerId Integer
    The ID of the instance-level runner to scope the controller to.
    updatedAt String
    The time the scope was last updated.
    createdAt string
    The time the scope was created.
    runnerControllerId number
    The ID of the runner controller.
    runnerId number
    The ID of the instance-level runner to scope the controller to.
    updatedAt string
    The time the scope was last updated.
    created_at str
    The time the scope was created.
    runner_controller_id int
    The ID of the runner controller.
    runner_id int
    The ID of the instance-level runner to scope the controller to.
    updated_at str
    The time the scope was last updated.
    createdAt String
    The time the scope was created.
    runnerControllerId Number
    The ID of the runner controller.
    runnerId Number
    The ID of the instance-level runner to scope the controller to.
    updatedAt String
    The time the scope 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.