Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gitlab Provider
  3. API Docs
  4. ProjectRunnerEnablement
GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab

gitlab.ProjectRunnerEnablement

Explore with Pulumi AI

GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab

The gitlab.ProjectRunnerEnablement resource allows to enable a runner in a project.

Upstream API: GitLab REST API docs

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const foo = new gitlab.ProjectRunnerEnablement("foo", {
    project: "5",
    runnerId: 7,
});
Copy
import pulumi
import pulumi_gitlab as gitlab

foo = gitlab.ProjectRunnerEnablement("foo",
    project="5",
    runner_id=7)
Copy
package main

import (
	"github.com/pulumi/pulumi-gitlab/sdk/v8/go/gitlab"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gitlab.NewProjectRunnerEnablement(ctx, "foo", &gitlab.ProjectRunnerEnablementArgs{
			Project:  pulumi.String("5"),
			RunnerId: pulumi.Int(7),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;

return await Deployment.RunAsync(() => 
{
    var foo = new GitLab.ProjectRunnerEnablement("foo", new()
    {
        Project = "5",
        RunnerId = 7,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.ProjectRunnerEnablement;
import com.pulumi.gitlab.ProjectRunnerEnablementArgs;
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 foo = new ProjectRunnerEnablement("foo", ProjectRunnerEnablementArgs.builder()
            .project(5)
            .runnerId(7)
            .build());

    }
}
Copy
resources:
  foo:
    type: gitlab:ProjectRunnerEnablement
    properties:
      project: 5
      runnerId: 7
Copy

Create ProjectRunnerEnablement Resource

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

Constructor syntax

new ProjectRunnerEnablement(name: string, args: ProjectRunnerEnablementArgs, opts?: CustomResourceOptions);
@overload
def ProjectRunnerEnablement(resource_name: str,
                            args: ProjectRunnerEnablementArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def ProjectRunnerEnablement(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            project: Optional[str] = None,
                            runner_id: Optional[int] = None)
func NewProjectRunnerEnablement(ctx *Context, name string, args ProjectRunnerEnablementArgs, opts ...ResourceOption) (*ProjectRunnerEnablement, error)
public ProjectRunnerEnablement(string name, ProjectRunnerEnablementArgs args, CustomResourceOptions? opts = null)
public ProjectRunnerEnablement(String name, ProjectRunnerEnablementArgs args)
public ProjectRunnerEnablement(String name, ProjectRunnerEnablementArgs args, CustomResourceOptions options)

type: gitlab:ProjectRunnerEnablement
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ProjectRunnerEnablementArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ProjectRunnerEnablementArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ProjectRunnerEnablementArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ProjectRunnerEnablementArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ProjectRunnerEnablementArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var projectRunnerEnablementResource = new GitLab.ProjectRunnerEnablement("projectRunnerEnablementResource", new()
{
    Project = "string",
    RunnerId = 0,
});
Copy
example, err := gitlab.NewProjectRunnerEnablement(ctx, "projectRunnerEnablementResource", &gitlab.ProjectRunnerEnablementArgs{
	Project:  pulumi.String("string"),
	RunnerId: pulumi.Int(0),
})
Copy
var projectRunnerEnablementResource = new ProjectRunnerEnablement("projectRunnerEnablementResource", ProjectRunnerEnablementArgs.builder()
    .project("string")
    .runnerId(0)
    .build());
Copy
project_runner_enablement_resource = gitlab.ProjectRunnerEnablement("projectRunnerEnablementResource",
    project="string",
    runner_id=0)
Copy
const projectRunnerEnablementResource = new gitlab.ProjectRunnerEnablement("projectRunnerEnablementResource", {
    project: "string",
    runnerId: 0,
});
Copy
type: gitlab:ProjectRunnerEnablement
properties:
    project: string
    runnerId: 0
Copy

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

Project
This property is required.
Changes to this property will trigger replacement.
string
The ID or URL-encoded path of the project owned by the authenticated user.
RunnerId
This property is required.
Changes to this property will trigger replacement.
int
The ID of a runner to enable for the project.
Project
This property is required.
Changes to this property will trigger replacement.
string
The ID or URL-encoded path of the project owned by the authenticated user.
RunnerId
This property is required.
Changes to this property will trigger replacement.
int
The ID of a runner to enable for the project.
project
This property is required.
Changes to this property will trigger replacement.
String
The ID or URL-encoded path of the project owned by the authenticated user.
runnerId
This property is required.
Changes to this property will trigger replacement.
Integer
The ID of a runner to enable for the project.
project
This property is required.
Changes to this property will trigger replacement.
string
The ID or URL-encoded path of the project owned by the authenticated user.
runnerId
This property is required.
Changes to this property will trigger replacement.
number
The ID of a runner to enable for the project.
project
This property is required.
Changes to this property will trigger replacement.
str
The ID or URL-encoded path of the project owned by the authenticated user.
runner_id
This property is required.
Changes to this property will trigger replacement.
int
The ID of a runner to enable for the project.
project
This property is required.
Changes to this property will trigger replacement.
String
The ID or URL-encoded path of the project owned by the authenticated user.
runnerId
This property is required.
Changes to this property will trigger replacement.
Number
The ID of a runner to enable for the project.

Outputs

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

Look up Existing ProjectRunnerEnablement Resource

Get an existing ProjectRunnerEnablement 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?: ProjectRunnerEnablementState, opts?: CustomResourceOptions): ProjectRunnerEnablement
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        project: Optional[str] = None,
        runner_id: Optional[int] = None) -> ProjectRunnerEnablement
func GetProjectRunnerEnablement(ctx *Context, name string, id IDInput, state *ProjectRunnerEnablementState, opts ...ResourceOption) (*ProjectRunnerEnablement, error)
public static ProjectRunnerEnablement Get(string name, Input<string> id, ProjectRunnerEnablementState? state, CustomResourceOptions? opts = null)
public static ProjectRunnerEnablement get(String name, Output<String> id, ProjectRunnerEnablementState state, CustomResourceOptions options)
resources:  _:    type: gitlab:ProjectRunnerEnablement    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Project Changes to this property will trigger replacement. string
The ID or URL-encoded path of the project owned by the authenticated user.
RunnerId Changes to this property will trigger replacement. int
The ID of a runner to enable for the project.
Project Changes to this property will trigger replacement. string
The ID or URL-encoded path of the project owned by the authenticated user.
RunnerId Changes to this property will trigger replacement. int
The ID of a runner to enable for the project.
project Changes to this property will trigger replacement. String
The ID or URL-encoded path of the project owned by the authenticated user.
runnerId Changes to this property will trigger replacement. Integer
The ID of a runner to enable for the project.
project Changes to this property will trigger replacement. string
The ID or URL-encoded path of the project owned by the authenticated user.
runnerId Changes to this property will trigger replacement. number
The ID of a runner to enable for the project.
project Changes to this property will trigger replacement. str
The ID or URL-encoded path of the project owned by the authenticated user.
runner_id Changes to this property will trigger replacement. int
The ID of a runner to enable for the project.
project Changes to this property will trigger replacement. String
The ID or URL-encoded path of the project owned by the authenticated user.
runnerId Changes to this property will trigger replacement. Number
The ID of a runner to enable for the project.

Import

Starting in Terraform v1.5.0 you can use an import block to import gitlab_project_runner_enablement. For example:

terraform

import {

to = gitlab_project_runner_enablement.example

id = “see CLI command below for ID”

}

Import using the CLI is supported using the following syntax:

GitLab project runners can be imported using an id made up of project:runner_id, e.g.

$ pulumi import gitlab:index/projectRunnerEnablement:ProjectRunnerEnablement foo 5:7
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
GitLab pulumi/pulumi-gitlab
License
Apache-2.0
Notes
This Pulumi package is based on the gitlab Terraform Provider.
GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab