Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/runner gitlab_runner}.
from cdktf_cdktf_provider_gitlab import runner
runner.Runner(
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,
registration_token: str,
access_level: str = None,
description: str = None,
id: str = None,
locked: typing.Union[bool, IResolvable] = None,
maintenance_note: str = None,
maximum_timeout: typing.Union[int, float] = None,
paused: typing.Union[bool, IResolvable] = None,
run_untagged: typing.Union[bool, IResolvable] = None,
tag_list: typing.List[str] = 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. |
registration_token |
str |
The registration token used to register the runner. |
access_level |
str |
The access_level of the runner. Valid values are: not_protected , ref_protected . |
description |
str |
The runner's description. |
id |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/runner#id Runner#id}. |
locked |
typing.Union[bool, cdktf.IResolvable] |
Whether the runner should be locked for current project. |
maintenance_note |
str |
Free-form maintenance notes for the runner (1024 characters). |
maximum_timeout |
typing.Union[int, float] |
Maximum timeout set when this runner handles the job. |
paused |
typing.Union[bool, cdktf.IResolvable] |
Whether the runner should ignore new jobs. |
run_untagged |
typing.Union[bool, cdktf.IResolvable] |
Whether the runner should handle untagged jobs. |
tag_list |
typing.List[str] |
List of runner’s tags. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: str
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
- Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
- Type: typing.List[cdktf.ITerraformDependable]
- Type: cdktf.ITerraformIterator
- Type: cdktf.TerraformResourceLifecycle
- Type: cdktf.TerraformProvider
- Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
- Type: str
The registration token used to register the runner.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/runner#registration_token Runner#registration_token}
- 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/runner#access_level Runner#access_level}
- Type: str
The runner's description.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/runner#description Runner#description}
- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/runner#id Runner#id}.
Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
- Type: typing.Union[bool, cdktf.IResolvable]
Whether the runner should be locked for current project.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/runner#locked Runner#locked}
- 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/runner#maintenance_note Runner#maintenance_note}
- Type: typing.Union[int, float]
Maximum timeout set when this runner handles the job.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/runner#maximum_timeout Runner#maximum_timeout}
- Type: typing.Union[bool, cdktf.IResolvable]
Whether the runner should ignore new jobs.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/runner#paused Runner#paused}
- Type: typing.Union[bool, cdktf.IResolvable]
Whether the runner should handle untagged jobs.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/runner#run_untagged Runner#run_untagged}
- Type: typing.List[str]
List of runner’s tags.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/runner#tag_list Runner#tag_list}
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_id |
No description. |
reset_locked |
No description. |
reset_maintenance_note |
No description. |
reset_maximum_timeout |
No description. |
reset_paused |
No description. |
reset_run_untagged |
No description. |
reset_tag_list |
No description. |
def to_string() -> str
Returns a string representation of this construct.
def add_override(
path: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
def override_logical_id(
new_logical_id: str
) -> None
Overrides the auto-generated logical ID with a specific ID.
- Type: str
The new logical ID to use for this stack element.
def reset_override_logical_id() -> None
Resets a previously passed logical Id to use the auto-generated logical id again.
def to_hcl_terraform() -> typing.Any
def to_metadata() -> typing.Any
def to_terraform() -> typing.Any
Adds this resource to the terraform JSON output.
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.
- Type: str
The string move target that will correspond to this resource.
def get_any_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Any]
- Type: str
def get_boolean_attribute(
terraform_attribute: str
) -> IResolvable
- Type: str
def get_boolean_map_attribute(
terraform_attribute: str
) -> typing.Mapping[bool]
- Type: str
def get_list_attribute(
terraform_attribute: str
) -> typing.List[str]
- Type: str
def get_number_attribute(
terraform_attribute: str
) -> typing.Union[int, float]
- Type: str
def get_number_list_attribute(
terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
- Type: str
def get_number_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
- Type: str
def get_string_attribute(
terraform_attribute: str
) -> str
- Type: str
def get_string_map_attribute(
terraform_attribute: str
) -> typing.Mapping[str]
- Type: str
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
def import_from(
id: str,
provider: TerraformProvider = None
) -> None
- Type: str
- Type: cdktf.TerraformProvider
def interpolation_for_attribute(
terraform_attribute: str
) -> IResolvable
- Type: str
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.
- Type: str
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
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.
- Type: str
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- 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.
def move_to_id(
id: str
) -> None
Moves this resource to the resource corresponding to "id".
- Type: str
Full id of resource to move to, e.g. "aws_s3_bucket.example".
def reset_access_level() -> None
def reset_description() -> None
def reset_id() -> None
def reset_locked() -> None
def reset_maintenance_note() -> None
def reset_maximum_timeout() -> None
def reset_paused() -> None
def reset_run_untagged() -> None
def reset_tag_list() -> None
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 Runner resource upon running "cdktf plan ". |
from cdktf_cdktf_provider_gitlab import runner
runner.Runner.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.
- Type: typing.Any
Any object.
from cdktf_cdktf_provider_gitlab import runner
runner.Runner.is_terraform_element(
x: typing.Any
)
- Type: typing.Any
from cdktf_cdktf_provider_gitlab import runner
runner.Runner.is_terraform_resource(
x: typing.Any
)
- Type: typing.Any
from cdktf_cdktf_provider_gitlab import runner
runner.Runner.generate_config_for_import(
scope: Construct,
import_to_id: str,
import_from_id: str,
provider: TerraformProvider = None
)
Generates CDKTF code for importing a Runner resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: str
The construct id used in the generated config for the Runner to import.
- Type: str
The id of the existing Runner that should be imported.
Refer to the {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/runner#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the Runner to import is found.
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. |
authentication_token |
str |
No description. |
status |
str |
No description. |
access_level_input |
str |
No description. |
description_input |
str |
No description. |
id_input |
str |
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. |
registration_token_input |
str |
No description. |
run_untagged_input |
typing.Union[bool, cdktf.IResolvable] |
No description. |
tag_list_input |
typing.List[str] |
No description. |
access_level |
str |
No description. |
description |
str |
No description. |
id |
str |
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. |
registration_token |
str |
No description. |
run_untagged |
typing.Union[bool, cdktf.IResolvable] |
No description. |
tag_list |
typing.List[str] |
No description. |
node: Node
- Type: constructs.Node
The tree node.
cdktf_stack: TerraformStack
- Type: cdktf.TerraformStack
fqn: str
- Type: str
friendly_unique_id: str
- Type: str
terraform_meta_arguments: typing.Mapping[typing.Any]
- Type: typing.Mapping[typing.Any]
terraform_resource_type: str
- Type: str
terraform_generator_metadata: TerraformProviderGeneratorMetadata
- Type: cdktf.TerraformProviderGeneratorMetadata
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
- Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
count: typing.Union[typing.Union[int, float], TerraformCount]
- Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_on: typing.List[str]
- Type: typing.List[str]
for_each: ITerraformIterator
- Type: cdktf.ITerraformIterator
lifecycle: TerraformResourceLifecycle
- Type: cdktf.TerraformResourceLifecycle
provider: TerraformProvider
- Type: cdktf.TerraformProvider
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
- Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
authentication_token: str
- Type: str
status: str
- Type: str
access_level_input: str
- Type: str
description_input: str
- Type: str
id_input: str
- Type: str
locked_input: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
maintenance_note_input: str
- Type: str
maximum_timeout_input: typing.Union[int, float]
- Type: typing.Union[int, float]
paused_input: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
registration_token_input: str
- Type: str
run_untagged_input: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
tag_list_input: typing.List[str]
- Type: typing.List[str]
access_level: str
- Type: str
description: str
- Type: str
id: str
- Type: str
locked: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
maintenance_note: str
- Type: str
maximum_timeout: typing.Union[int, float]
- Type: typing.Union[int, float]
paused: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
registration_token: str
- Type: str
run_untagged: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
tag_list: typing.List[str]
- Type: typing.List[str]
Name | Type | Description |
---|---|---|
tfResourceType |
str |
No description. |
tfResourceType: str
- Type: str
from cdktf_cdktf_provider_gitlab import runner
runner.RunnerConfig(
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,
registration_token: str,
access_level: str = None,
description: str = None,
id: str = None,
locked: typing.Union[bool, IResolvable] = None,
maintenance_note: str = None,
maximum_timeout: typing.Union[int, float] = None,
paused: typing.Union[bool, IResolvable] = None,
run_untagged: typing.Union[bool, IResolvable] = None,
tag_list: typing.List[str] = None
)
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. |
registration_token |
str |
The registration token used to register the runner. |
access_level |
str |
The access_level of the runner. Valid values are: not_protected , ref_protected . |
description |
str |
The runner's description. |
id |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/runner#id Runner#id}. |
locked |
typing.Union[bool, cdktf.IResolvable] |
Whether the runner should be locked for current project. |
maintenance_note |
str |
Free-form maintenance notes for the runner (1024 characters). |
maximum_timeout |
typing.Union[int, float] |
Maximum timeout set when this runner handles the job. |
paused |
typing.Union[bool, cdktf.IResolvable] |
Whether the runner should ignore new jobs. |
run_untagged |
typing.Union[bool, cdktf.IResolvable] |
Whether the runner should handle untagged jobs. |
tag_list |
typing.List[str] |
List of runner’s tags. |
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
- Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
count: typing.Union[typing.Union[int, float], TerraformCount]
- Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_on: typing.List[ITerraformDependable]
- Type: typing.List[cdktf.ITerraformDependable]
for_each: ITerraformIterator
- Type: cdktf.ITerraformIterator
lifecycle: TerraformResourceLifecycle
- Type: cdktf.TerraformResourceLifecycle
provider: TerraformProvider
- Type: cdktf.TerraformProvider
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
- Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
registration_token: str
- Type: str
The registration token used to register the runner.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/runner#registration_token Runner#registration_token}
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/runner#access_level Runner#access_level}
description: str
- Type: str
The runner's description.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/runner#description Runner#description}
id: str
- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/runner#id Runner#id}.
Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
locked: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
Whether the runner should be locked for current project.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/runner#locked Runner#locked}
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/runner#maintenance_note Runner#maintenance_note}
maximum_timeout: typing.Union[int, float]
- Type: typing.Union[int, float]
Maximum timeout set when this runner handles the job.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/runner#maximum_timeout Runner#maximum_timeout}
paused: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
Whether the runner should ignore new jobs.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/runner#paused Runner#paused}
run_untagged: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
Whether the runner should handle untagged jobs.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/runner#run_untagged Runner#run_untagged}
tag_list: typing.List[str]
- Type: typing.List[str]
List of runner’s tags.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/runner#tag_list Runner#tag_list}