Skip to content

Latest commit

 

History

History
1514 lines (961 loc) · 59.5 KB

userRunner.python.md

File metadata and controls

1514 lines (961 loc) · 59.5 KB
Raw

userRunner Submodule

Constructs

UserRunner

Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner gitlab_user_runner}.

Initializers 

from cdktf_cdktf_provider_gitlab import user_runner

userRunner.UserRunner(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  runner_type: str,
  access_level: str = None,
  description: str = None,
  group_id: typing.Union[int, float] = None,
  locked: typing.Union[bool, IResolvable] = None,
  maintenance_note: str = None,
  maximum_timeout: typing.Union[int, float] = None,
  paused: typing.Union[bool, IResolvable] = None,
  project_id: typing.Union[int, float] = None,
  tag_list: typing.List[str] = None,
  untagged: typing.Union[bool, IResolvable] = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
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 typing.Union[int, float] The ID of the group that the runner is created in. Required if runner_type is group_type.
locked typing.Union[bool, cdktf.IResolvable] Specifies if the runner should be locked for the current project.
maintenance_note str Free-form maintenance notes for the runner (1024 characters).
maximum_timeout typing.Union[int, float] Maximum timeout that limits the amount of time (in seconds) that runners can run jobs.
paused typing.Union[bool, cdktf.IResolvable] Specifies if the runner should ignore new jobs.
project_id typing.Union[int, float] The ID of the project that the runner is created in. Required if runner_type is project_type.
tag_list typing.List[str] A list of runner tags.
untagged typing.Union[bool, cdktf.IResolvable] Specifies if the runner should handle untagged jobs.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
runner_typeRequired
  • Type: str

The scope of the runner. Valid values are: instance_type, group_type, project_type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#runner_type UserRunner#runner_type}

access_levelOptional
  • Type: str

The access level of the runner. Valid values are: not_protected, ref_protected.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#access_level UserRunner#access_level}

descriptionOptional
  • Type: str

Description of the runner.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#description UserRunner#description}

group_idOptional
  • Type: typing.Union[int, float]

The ID of the group that the runner is created in. Required if runner_type is group_type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#group_id UserRunner#group_id}

lockedOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Specifies if the runner should be locked for the current project.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#locked UserRunner#locked}

maintenance_noteOptional
  • Type: str

Free-form maintenance notes for the runner (1024 characters).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#maintenance_note UserRunner#maintenance_note}

maximum_timeoutOptional
  • Type: typing.Union[int, float]

Maximum timeout that limits the amount of time (in seconds) that runners can run jobs.

Must be at least 600 (10 minutes).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#maximum_timeout UserRunner#maximum_timeout}

pausedOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Specifies if the runner should ignore new jobs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#paused UserRunner#paused}

project_idOptional
  • Type: typing.Union[int, float]

The ID of the project that the runner is created in. Required if runner_type is project_type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#project_id UserRunner#project_id}

tag_listOptional
  • Type: typing.List[str]

A list of runner tags.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#tag_list UserRunner#tag_list}

untaggedOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Specifies if the runner should handle untagged jobs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#untagged UserRunner#untagged}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
reset_access_level No description.
reset_description No description.
reset_group_id No description.
reset_locked No description.
reset_maintenance_note No description.
reset_maximum_timeout No description.
reset_paused No description.
reset_project_id No description.
reset_tag_list No description.
reset_untagged No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

move_to_id 
def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

reset_access_level 
def reset_access_level() -> None
reset_description 
def reset_description() -> None
reset_group_id 
def reset_group_id() -> None
reset_locked 
def reset_locked() -> None
reset_maintenance_note 
def reset_maintenance_note() -> None
reset_maximum_timeout 
def reset_maximum_timeout() -> None
reset_paused 
def reset_paused() -> None
reset_project_id 
def reset_project_id() -> None
reset_tag_list 
def reset_tag_list() -> None
reset_untagged 
def reset_untagged() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a UserRunner resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_gitlab import user_runner

userRunner.UserRunner.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_gitlab import user_runner

userRunner.UserRunner.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_gitlab import user_runner

userRunner.UserRunner.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_gitlab import user_runner

userRunner.UserRunner.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a UserRunner resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

The construct id used in the generated config for the UserRunner to import.

import_from_idRequired
  • Type: str

The id of the existing UserRunner that should be imported.

Refer to the {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the UserRunner to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
id str No description.
token str No description.
access_level_input str No description.
description_input str No description.
group_id_input typing.Union[int, float] No description.
locked_input typing.Union[bool, cdktf.IResolvable] No description.
maintenance_note_input str No description.
maximum_timeout_input typing.Union[int, float] No description.
paused_input typing.Union[bool, cdktf.IResolvable] No description.
project_id_input typing.Union[int, float] No description.
runner_type_input str No description.
tag_list_input typing.List[str] No description.
untagged_input typing.Union[bool, cdktf.IResolvable] No description.
access_level str No description.
description str No description.
group_id typing.Union[int, float] No description.
locked typing.Union[bool, cdktf.IResolvable] No description.
maintenance_note str No description.
maximum_timeout typing.Union[int, float] No description.
paused typing.Union[bool, cdktf.IResolvable] No description.
project_id typing.Union[int, float] No description.
runner_type str No description.
tag_list typing.List[str] No description.
untagged typing.Union[bool, cdktf.IResolvable] No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
idRequired 
id: str
  • Type: str
tokenRequired 
token: str
  • Type: str
access_level_inputOptional 
access_level_input: str
  • Type: str
description_inputOptional 
description_input: str
  • Type: str
group_id_inputOptional 
group_id_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
locked_inputOptional 
locked_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
maintenance_note_inputOptional 
maintenance_note_input: str
  • Type: str
maximum_timeout_inputOptional 
maximum_timeout_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
paused_inputOptional 
paused_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
project_id_inputOptional 
project_id_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
runner_type_inputOptional 
runner_type_input: str
  • Type: str
tag_list_inputOptional 
tag_list_input: typing.List[str]
  • Type: typing.List[str]
untagged_inputOptional 
untagged_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
access_levelRequired 
access_level: str
  • Type: str
descriptionRequired 
description: str
  • Type: str
group_idRequired 
group_id: typing.Union[int, float]
  • Type: typing.Union[int, float]
lockedRequired 
locked: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
maintenance_noteRequired 
maintenance_note: str
  • Type: str
maximum_timeoutRequired 
maximum_timeout: typing.Union[int, float]
  • Type: typing.Union[int, float]
pausedRequired 
paused: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
project_idRequired 
project_id: typing.Union[int, float]
  • Type: typing.Union[int, float]
runner_typeRequired 
runner_type: str
  • Type: str
tag_listRequired 
tag_list: typing.List[str]
  • Type: typing.List[str]
untaggedRequired 
untagged: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

UserRunnerConfig

Initializer 

from cdktf_cdktf_provider_gitlab import user_runner

userRunner.UserRunnerConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  runner_type: str,
  access_level: str = None,
  description: str = None,
  group_id: typing.Union[int, float] = None,
  locked: typing.Union[bool, IResolvable] = None,
  maintenance_note: str = None,
  maximum_timeout: typing.Union[int, float] = None,
  paused: typing.Union[bool, IResolvable] = None,
  project_id: typing.Union[int, float] = None,
  tag_list: typing.List[str] = None,
  untagged: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
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 typing.Union[int, float] The ID of the group that the runner is created in. Required if runner_type is group_type.
locked typing.Union[bool, cdktf.IResolvable] Specifies if the runner should be locked for the current project.
maintenance_note str Free-form maintenance notes for the runner (1024 characters).
maximum_timeout typing.Union[int, float] Maximum timeout that limits the amount of time (in seconds) that runners can run jobs.
paused typing.Union[bool, cdktf.IResolvable] Specifies if the runner should ignore new jobs.
project_id typing.Union[int, float] The ID of the project that the runner is created in. Required if runner_type is project_type.
tag_list typing.List[str] A list of runner tags.
untagged typing.Union[bool, cdktf.IResolvable] Specifies if the runner should handle untagged jobs.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
runner_typeRequired 
runner_type: str
  • Type: str

The scope of the runner. Valid values are: instance_type, group_type, project_type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#runner_type UserRunner#runner_type}

access_levelOptional 
access_level: str
  • Type: str

The access level of the runner. Valid values are: not_protected, ref_protected.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#access_level UserRunner#access_level}

descriptionOptional 
description: str
  • Type: str

Description of the runner.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#description UserRunner#description}

group_idOptional 
group_id: typing.Union[int, float]
  • Type: typing.Union[int, float]

The ID of the group that the runner is created in. Required if runner_type is group_type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#group_id UserRunner#group_id}

lockedOptional 
locked: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Specifies if the runner should be locked for the current project.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#locked UserRunner#locked}

maintenance_noteOptional 
maintenance_note: str
  • Type: str

Free-form maintenance notes for the runner (1024 characters).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#maintenance_note UserRunner#maintenance_note}

maximum_timeoutOptional 
maximum_timeout: typing.Union[int, float]
  • Type: typing.Union[int, float]

Maximum timeout that limits the amount of time (in seconds) that runners can run jobs.

Must be at least 600 (10 minutes).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#maximum_timeout UserRunner#maximum_timeout}

pausedOptional 
paused: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Specifies if the runner should ignore new jobs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#paused UserRunner#paused}

project_idOptional 
project_id: typing.Union[int, float]
  • Type: typing.Union[int, float]

The ID of the project that the runner is created in. Required if runner_type is project_type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#project_id UserRunner#project_id}

tag_listOptional 
tag_list: typing.List[str]
  • Type: typing.List[str]

A list of runner tags.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#tag_list UserRunner#tag_list}

untaggedOptional 
untagged: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Specifies if the runner should handle untagged jobs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/user_runner#untagged UserRunner#untagged}