userrunner

package
v13.6.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 20, 2024 License: MPL-2.0 Imports: 7 Imported by: 0

README

gitlab_user_runner

Refer to the Terraform Registry for docs: gitlab_user_runner.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewUserRunner_Override 

func NewUserRunner_Override(u UserRunner, scope constructs.Construct, id *string, config *UserRunnerConfig)

Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/user_runner gitlab_user_runner} Resource.

func UserRunner_GenerateConfigForImport 

func UserRunner_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource

Generates CDKTF code for importing a UserRunner resource upon running "cdktf plan <stack-name>".

func UserRunner_IsConstruct 

func UserRunner_IsConstruct(x interface{}) *bool

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.

Returns: true if `x` is an object created from a class which extends `Construct`.

func UserRunner_IsTerraformElement 

func UserRunner_IsTerraformElement(x interface{}) *bool

Experimental.

func UserRunner_IsTerraformResource 

func UserRunner_IsTerraformResource(x interface{}) *bool

Experimental.

func UserRunner_TfResourceType 

func UserRunner_TfResourceType() *string

Types

type UserRunner 

type UserRunner interface {
	cdktf.TerraformResource
	AccessLevel() *string
	SetAccessLevel(val *string)
	AccessLevelInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	Description() *string
	SetDescription(val *string)
	DescriptionInput() *string
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	GroupId() *float64
	SetGroupId(val *float64)
	GroupIdInput() *float64
	Id() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Locked() interface{}
	SetLocked(val interface{})
	LockedInput() interface{}
	MaintenanceNote() *string
	SetMaintenanceNote(val *string)
	MaintenanceNoteInput() *string
	MaximumTimeout() *float64
	SetMaximumTimeout(val *float64)
	MaximumTimeoutInput() *float64
	// The tree node.
	Node() constructs.Node
	Paused() interface{}
	SetPaused(val interface{})
	PausedInput() interface{}
	ProjectId() *float64
	SetProjectId(val *float64)
	ProjectIdInput() *float64
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	RunnerType() *string
	SetRunnerType(val *string)
	RunnerTypeInput() *string
	TagList() *[]*string
	SetTagList(val *[]*string)
	TagListInput() *[]*string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Token() *string
	Untagged() interface{}
	SetUntagged(val interface{})
	UntaggedInput() interface{}
	// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
	// Experimental.
	AddMoveTarget(moveTarget *string)
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	HasResourceMove() interface{}
	// Experimental.
	ImportFrom(id *string, provider cdktf.TerraformProvider)
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// 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.
	// Experimental.
	MoveFromId(id *string)
	// Moves this resource to the target resource given by moveTarget.
	// Experimental.
	MoveTo(moveTarget *string, index interface{})
	// Moves this resource to the resource corresponding to "id".
	// Experimental.
	MoveToId(id *string)
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetAccessLevel()
	ResetDescription()
	ResetGroupId()
	ResetLocked()
	ResetMaintenanceNote()
	ResetMaximumTimeout()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetPaused()
	ResetProjectId()
	ResetTagList()
	ResetUntagged()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// Experimental.
	ToHclTerraform() interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

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

func NewUserRunner 

func NewUserRunner(scope constructs.Construct, id *string, config *UserRunnerConfig) UserRunner

Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/user_runner gitlab_user_runner} Resource.

type UserRunnerConfig 

type UserRunnerConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// 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.7.0/docs/resources/user_runner#runner_type UserRunner#runner_type}
	RunnerType *string `field:"required" json:"runnerType" yaml:"runnerType"`
	// 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.7.0/docs/resources/user_runner#access_level UserRunner#access_level}
	AccessLevel *string `field:"optional" json:"accessLevel" yaml:"accessLevel"`
	// Description of the runner.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/user_runner#description UserRunner#description}
	Description *string `field:"optional" json:"description" yaml:"description"`
	// 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.7.0/docs/resources/user_runner#group_id UserRunner#group_id}
	GroupId *float64 `field:"optional" json:"groupId" yaml:"groupId"`
	// Specifies if the runner should be locked for the current project.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/user_runner#locked UserRunner#locked}
	Locked interface{} `field:"optional" json:"locked" yaml:"locked"`
	// Free-form maintenance notes for the runner (1024 characters).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/user_runner#maintenance_note UserRunner#maintenance_note}
	MaintenanceNote *string `field:"optional" json:"maintenanceNote" yaml:"maintenanceNote"`
	// 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.7.0/docs/resources/user_runner#maximum_timeout UserRunner#maximum_timeout}
	MaximumTimeout *float64 `field:"optional" json:"maximumTimeout" yaml:"maximumTimeout"`
	// Specifies if the runner should ignore new jobs.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/user_runner#paused UserRunner#paused}
	Paused interface{} `field:"optional" json:"paused" yaml:"paused"`
	// 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.7.0/docs/resources/user_runner#project_id UserRunner#project_id}
	ProjectId *float64 `field:"optional" json:"projectId" yaml:"projectId"`
	// A list of runner tags.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/user_runner#tag_list UserRunner#tag_list}
	TagList *[]*string `field:"optional" json:"tagList" yaml:"tagList"`
	// Specifies if the runner should handle untagged jobs.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/user_runner#untagged UserRunner#untagged}
	Untagged interface{} `field:"optional" json:"untagged" yaml:"untagged"`
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.