Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gitlab Provider
  3. API Docs
  4. ProjectRunnerEnablement
GitLab v8.5.0 published on Friday, Oct 18, 2024 by Pulumi
pulumi/pulumi-gitlab

gitlab.ProjectRunnerEnablement

Explore with Pulumi AI

gitlab logo
GitLab v8.5.0 published on Friday, Oct 18, 2024 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,
});

    import pulumi
import pulumi_gitlab as gitlab

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

    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
	})
}

    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,
    });

});

    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());

    }
}

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

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

    example, err := gitlab.NewProjectRunnerEnablement(ctx, "projectRunnerEnablementResource", &gitlab.ProjectRunnerEnablementArgs{
	Project:  pulumi.String("string"),
	RunnerId: pulumi.Int(0),
})

    var projectRunnerEnablementResource = new ProjectRunnerEnablement("projectRunnerEnablementResource", ProjectRunnerEnablementArgs.builder()
    .project("string")
    .runnerId(0)
    .build());

    project_runner_enablement_resource = gitlab.ProjectRunnerEnablement("projectRunnerEnablementResource",
    project="string",
    runner_id=0)

    const projectRunnerEnablementResource = new gitlab.ProjectRunnerEnablement("projectRunnerEnablementResource", {
    project: "string",
    runnerId: 0,
});

    type: gitlab:ProjectRunnerEnablement
properties:
    project: string
    runnerId: 0

    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 string
    The ID or URL-encoded path of the project owned by the authenticated user.
    RunnerId int
    The ID of a runner to enable for the project.
    Project string
    The ID or URL-encoded path of the project owned by the authenticated user.
    RunnerId int
    The ID of a runner to enable for the project.
    project String
    The ID or URL-encoded path of the project owned by the authenticated user.
    runnerId Integer
    The ID of a runner to enable for the project.
    project string
    The ID or URL-encoded path of the project owned by the authenticated user.
    runnerId number
    The ID of a runner to enable for the project.
    project str
    The ID or URL-encoded path of the project owned by the authenticated user.
    runner_id int
    The ID of a runner to enable for the project.
    project String
    The ID or URL-encoded path of the project owned by the authenticated user.
    runnerId 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)
    Resource lookup is not supported in YAML
    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:
    Project string
    The ID or URL-encoded path of the project owned by the authenticated user.
    RunnerId int
    The ID of a runner to enable for the project.
    Project string
    The ID or URL-encoded path of the project owned by the authenticated user.
    RunnerId int
    The ID of a runner to enable for the project.
    project String
    The ID or URL-encoded path of the project owned by the authenticated user.
    runnerId Integer
    The ID of a runner to enable for the project.
    project string
    The ID or URL-encoded path of the project owned by the authenticated user.
    runnerId number
    The ID of a runner to enable for the project.
    project str
    The ID or URL-encoded path of the project owned by the authenticated user.
    runner_id int
    The ID of a runner to enable for the project.
    project String
    The ID or URL-encoded path of the project owned by the authenticated user.
    runnerId Number
    The ID of a runner to enable for the project.

    Import

    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

    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 logo
    GitLab v8.5.0 published on Friday, Oct 18, 2024 by Pulumi
    pulumi/pulumi-gitlab