Docs Packages
  1. Packages
  2. GitLab
  3. API Docs
  4. UserRunner
GitLab v6.11.0 published on Friday, Apr 19, 2024 by Pulumi
pulumi/pulumi-gitlab

gitlab.UserRunner

Explore with Pulumi AI

gitlab logo
GitLab v6.11.0 published on Friday, Apr 19, 2024 by Pulumi
pulumi/pulumi-gitlab

    The gitlab.UserRunner resource allows creating a GitLab runner using the new GitLab Runner Registration Flow.

    Upstream API: GitLab REST API docs

    Create UserRunner Resource

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

    Constructor syntax

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

@overload
def UserRunner(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               runner_type: Optional[str] = None,
               access_level: Optional[str] = None,
               description: Optional[str] = None,
               group_id: Optional[int] = None,
               locked: Optional[bool] = None,
               maximum_timeout: Optional[int] = None,
               paused: Optional[bool] = None,
               project_id: Optional[int] = None,
               tag_lists: Optional[Sequence[str]] = None,
               untagged: Optional[bool] = None)
    func NewUserRunner(ctx *Context, name string, args UserRunnerArgs, opts ...ResourceOption) (*UserRunner, error)
    public UserRunner(string name, UserRunnerArgs args, CustomResourceOptions? opts = null)
    public UserRunner(String name, UserRunnerArgs args)
public UserRunner(String name, UserRunnerArgs args, CustomResourceOptions options)

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

    Example

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

    var userRunnerResource = new GitLab.UserRunner("userRunnerResource", new()
{
    RunnerType = "string",
    AccessLevel = "string",
    Description = "string",
    GroupId = 0,
    Locked = false,
    MaximumTimeout = 0,
    Paused = false,
    ProjectId = 0,
    TagLists = new[]
    {
        "string",
    },
    Untagged = false,
});

    example, err := gitlab.NewUserRunner(ctx, "userRunnerResource", &gitlab.UserRunnerArgs{
	RunnerType:     pulumi.String("string"),
	AccessLevel:    pulumi.String("string"),
	Description:    pulumi.String("string"),
	GroupId:        pulumi.Int(0),
	Locked:         pulumi.Bool(false),
	MaximumTimeout: pulumi.Int(0),
	Paused:         pulumi.Bool(false),
	ProjectId:      pulumi.Int(0),
	TagLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	Untagged: pulumi.Bool(false),
})

    var userRunnerResource = new UserRunner("userRunnerResource", UserRunnerArgs.builder()        
    .runnerType("string")
    .accessLevel("string")
    .description("string")
    .groupId(0)
    .locked(false)
    .maximumTimeout(0)
    .paused(false)
    .projectId(0)
    .tagLists("string")
    .untagged(false)
    .build());

    user_runner_resource = gitlab.UserRunner("userRunnerResource",
    runner_type="string",
    access_level="string",
    description="string",
    group_id=0,
    locked=False,
    maximum_timeout=0,
    paused=False,
    project_id=0,
    tag_lists=["string"],
    untagged=False)

    const userRunnerResource = new gitlab.UserRunner("userRunnerResource", {
    runnerType: "string",
    accessLevel: "string",
    description: "string",
    groupId: 0,
    locked: false,
    maximumTimeout: 0,
    paused: false,
    projectId: 0,
    tagLists: ["string"],
    untagged: false,
});

    type: gitlab:UserRunner
properties:
    accessLevel: string
    description: string
    groupId: 0
    locked: false
    maximumTimeout: 0
    paused: false
    projectId: 0
    runnerType: string
    tagLists:
        - string
    untagged: false

    UserRunner Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The UserRunner resource accepts the following input properties:

    RunnerType string
    The scope of the runner. Valid values are: instance_type, group_type, project_type.
    AccessLevel string
    The access level of the runner. Valid values are: not_protected, ref_protected.
    Description string
    Description of the runner.
    GroupId int
    The ID of the group that the runner is created in. Required if runnertype is grouptype.
    Locked bool
    Specifies if the runner should be locked for the current project.
    MaximumTimeout int
    Maximum timeout that limits the amount of time (in seconds) that runners can run jobs. Must be at least 600 (10 minutes).
    Paused bool
    Specifies if the runner should ignore new jobs.
    ProjectId int
    The ID of the project that the runner is created in. Required if runnertype is projecttype.
    TagLists List<string>
    A list of runner tags.
    Untagged bool
    Specifies if the runner should handle untagged jobs.
    RunnerType string
    The scope of the runner. Valid values are: instance_type, group_type, project_type.
    AccessLevel string
    The access level of the runner. Valid values are: not_protected, ref_protected.
    Description string
    Description of the runner.
    GroupId int
    The ID of the group that the runner is created in. Required if runnertype is grouptype.
    Locked bool
    Specifies if the runner should be locked for the current project.
    MaximumTimeout int
    Maximum timeout that limits the amount of time (in seconds) that runners can run jobs. Must be at least 600 (10 minutes).
    Paused bool
    Specifies if the runner should ignore new jobs.
    ProjectId int
    The ID of the project that the runner is created in. Required if runnertype is projecttype.
    TagLists []string
    A list of runner tags.
    Untagged bool
    Specifies if the runner should handle untagged jobs.
    runnerType String
    The scope of the runner. Valid values are: instance_type, group_type, project_type.
    accessLevel String
    The access level of the runner. Valid values are: not_protected, ref_protected.
    description String
    Description of the runner.
    groupId Integer
    The ID of the group that the runner is created in. Required if runnertype is grouptype.
    locked Boolean
    Specifies if the runner should be locked for the current project.
    maximumTimeout Integer
    Maximum timeout that limits the amount of time (in seconds) that runners can run jobs. Must be at least 600 (10 minutes).
    paused Boolean
    Specifies if the runner should ignore new jobs.
    projectId Integer
    The ID of the project that the runner is created in. Required if runnertype is projecttype.
    tagLists List<String>
    A list of runner tags.
    untagged Boolean
    Specifies if the runner should handle untagged jobs.
    runnerType string
    The scope of the runner. Valid values are: instance_type, group_type, project_type.
    accessLevel string
    The access level of the runner. Valid values are: not_protected, ref_protected.
    description string
    Description of the runner.
    groupId number
    The ID of the group that the runner is created in. Required if runnertype is grouptype.
    locked boolean
    Specifies if the runner should be locked for the current project.
    maximumTimeout number
    Maximum timeout that limits the amount of time (in seconds) that runners can run jobs. Must be at least 600 (10 minutes).
    paused boolean
    Specifies if the runner should ignore new jobs.
    projectId number
    The ID of the project that the runner is created in. Required if runnertype is projecttype.
    tagLists string[]
    A list of runner tags.
    untagged boolean
    Specifies if the runner should handle untagged jobs.
    runner_type str
    The scope of the runner. Valid values are: instance_type, group_type, project_type.
    access_level str
    The access level of the runner. Valid values are: not_protected, ref_protected.
    description str
    Description of the runner.
    group_id int
    The ID of the group that the runner is created in. Required if runnertype is grouptype.
    locked bool
    Specifies if the runner should be locked for the current project.
    maximum_timeout int
    Maximum timeout that limits the amount of time (in seconds) that runners can run jobs. Must be at least 600 (10 minutes).
    paused bool
    Specifies if the runner should ignore new jobs.
    project_id int
    The ID of the project that the runner is created in. Required if runnertype is projecttype.
    tag_lists Sequence[str]
    A list of runner tags.
    untagged bool
    Specifies if the runner should handle untagged jobs.
    runnerType String
    The scope of the runner. Valid values are: instance_type, group_type, project_type.
    accessLevel String
    The access level of the runner. Valid values are: not_protected, ref_protected.
    description String
    Description of the runner.
    groupId Number
    The ID of the group that the runner is created in. Required if runnertype is grouptype.
    locked Boolean
    Specifies if the runner should be locked for the current project.
    maximumTimeout Number
    Maximum timeout that limits the amount of time (in seconds) that runners can run jobs. Must be at least 600 (10 minutes).
    paused Boolean
    Specifies if the runner should ignore new jobs.
    projectId Number
    The ID of the project that the runner is created in. Required if runnertype is projecttype.
    tagLists List<String>
    A list of runner tags.
    untagged Boolean
    Specifies if the runner should handle untagged jobs.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The authentication token to use when setting up a new runner with this configuration. This value cannot be imported.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The authentication token to use when setting up a new runner with this configuration. This value cannot be imported.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The authentication token to use when setting up a new runner with this configuration. This value cannot be imported.
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    The authentication token to use when setting up a new runner with this configuration. This value cannot be imported.
    id str
    The provider-assigned unique ID for this managed resource.
    token str
    The authentication token to use when setting up a new runner with this configuration. This value cannot be imported.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The authentication token to use when setting up a new runner with this configuration. This value cannot be imported.

    Look up Existing UserRunner Resource

    Get an existing UserRunner 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?: UserRunnerState, opts?: CustomResourceOptions): UserRunner
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_level: Optional[str] = None,
        description: Optional[str] = None,
        group_id: Optional[int] = None,
        locked: Optional[bool] = None,
        maximum_timeout: Optional[int] = None,
        paused: Optional[bool] = None,
        project_id: Optional[int] = None,
        runner_type: Optional[str] = None,
        tag_lists: Optional[Sequence[str]] = None,
        token: Optional[str] = None,
        untagged: Optional[bool] = None) -> UserRunner
    func GetUserRunner(ctx *Context, name string, id IDInput, state *UserRunnerState, opts ...ResourceOption) (*UserRunner, error)
    public static UserRunner Get(string name, Input<string> id, UserRunnerState? state, CustomResourceOptions? opts = null)
    public static UserRunner get(String name, Output<String> id, UserRunnerState 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:
    AccessLevel string
    The access level of the runner. Valid values are: not_protected, ref_protected.
    Description string
    Description of the runner.
    GroupId int
    The ID of the group that the runner is created in. Required if runnertype is grouptype.
    Locked bool
    Specifies if the runner should be locked for the current project.
    MaximumTimeout int
    Maximum timeout that limits the amount of time (in seconds) that runners can run jobs. Must be at least 600 (10 minutes).
    Paused bool
    Specifies if the runner should ignore new jobs.
    ProjectId int
    The ID of the project that the runner is created in. Required if runnertype is projecttype.
    RunnerType string
    The scope of the runner. Valid values are: instance_type, group_type, project_type.
    TagLists List<string>
    A list of runner tags.
    Token string
    The authentication token to use when setting up a new runner with this configuration. This value cannot be imported.
    Untagged bool
    Specifies if the runner should handle untagged jobs.
    AccessLevel string
    The access level of the runner. Valid values are: not_protected, ref_protected.
    Description string
    Description of the runner.
    GroupId int
    The ID of the group that the runner is created in. Required if runnertype is grouptype.
    Locked bool
    Specifies if the runner should be locked for the current project.
    MaximumTimeout int
    Maximum timeout that limits the amount of time (in seconds) that runners can run jobs. Must be at least 600 (10 minutes).
    Paused bool
    Specifies if the runner should ignore new jobs.
    ProjectId int
    The ID of the project that the runner is created in. Required if runnertype is projecttype.
    RunnerType string
    The scope of the runner. Valid values are: instance_type, group_type, project_type.
    TagLists []string
    A list of runner tags.
    Token string
    The authentication token to use when setting up a new runner with this configuration. This value cannot be imported.
    Untagged bool
    Specifies if the runner should handle untagged jobs.
    accessLevel String
    The access level of the runner. Valid values are: not_protected, ref_protected.
    description String
    Description of the runner.
    groupId Integer
    The ID of the group that the runner is created in. Required if runnertype is grouptype.
    locked Boolean
    Specifies if the runner should be locked for the current project.
    maximumTimeout Integer
    Maximum timeout that limits the amount of time (in seconds) that runners can run jobs. Must be at least 600 (10 minutes).
    paused Boolean
    Specifies if the runner should ignore new jobs.
    projectId Integer
    The ID of the project that the runner is created in. Required if runnertype is projecttype.
    runnerType String
    The scope of the runner. Valid values are: instance_type, group_type, project_type.
    tagLists List<String>
    A list of runner tags.
    token String
    The authentication token to use when setting up a new runner with this configuration. This value cannot be imported.
    untagged Boolean
    Specifies if the runner should handle untagged jobs.
    accessLevel string
    The access level of the runner. Valid values are: not_protected, ref_protected.
    description string
    Description of the runner.
    groupId number
    The ID of the group that the runner is created in. Required if runnertype is grouptype.
    locked boolean
    Specifies if the runner should be locked for the current project.
    maximumTimeout number
    Maximum timeout that limits the amount of time (in seconds) that runners can run jobs. Must be at least 600 (10 minutes).
    paused boolean
    Specifies if the runner should ignore new jobs.
    projectId number
    The ID of the project that the runner is created in. Required if runnertype is projecttype.
    runnerType string
    The scope of the runner. Valid values are: instance_type, group_type, project_type.
    tagLists string[]
    A list of runner tags.
    token string
    The authentication token to use when setting up a new runner with this configuration. This value cannot be imported.
    untagged boolean
    Specifies if the runner should handle untagged jobs.
    access_level str
    The access level of the runner. Valid values are: not_protected, ref_protected.
    description str
    Description of the runner.
    group_id int
    The ID of the group that the runner is created in. Required if runnertype is grouptype.
    locked bool
    Specifies if the runner should be locked for the current project.
    maximum_timeout int
    Maximum timeout that limits the amount of time (in seconds) that runners can run jobs. Must be at least 600 (10 minutes).
    paused bool
    Specifies if the runner should ignore new jobs.
    project_id int
    The ID of the project that the runner is created in. Required if runnertype is projecttype.
    runner_type str
    The scope of the runner. Valid values are: instance_type, group_type, project_type.
    tag_lists Sequence[str]
    A list of runner tags.
    token str
    The authentication token to use when setting up a new runner with this configuration. This value cannot be imported.
    untagged bool
    Specifies if the runner should handle untagged jobs.
    accessLevel String
    The access level of the runner. Valid values are: not_protected, ref_protected.
    description String
    Description of the runner.
    groupId Number
    The ID of the group that the runner is created in. Required if runnertype is grouptype.
    locked Boolean
    Specifies if the runner should be locked for the current project.
    maximumTimeout Number
    Maximum timeout that limits the amount of time (in seconds) that runners can run jobs. Must be at least 600 (10 minutes).
    paused Boolean
    Specifies if the runner should ignore new jobs.
    projectId Number
    The ID of the project that the runner is created in. Required if runnertype is projecttype.
    runnerType String
    The scope of the runner. Valid values are: instance_type, group_type, project_type.
    tagLists List<String>
    A list of runner tags.
    token String
    The authentication token to use when setting up a new runner with this configuration. This value cannot be imported.
    untagged Boolean
    Specifies if the runner should handle untagged jobs.

    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 v6.11.0 published on Friday, Apr 19, 2024 by Pulumi
    pulumi/pulumi-gitlab