pipelineschedule

README

gitlab_pipeline_schedule

Refer to the Terraform Registry for docs: gitlab_pipeline_schedule.

Documentation

Index

• func NewPipelineSchedule_Override(p PipelineSchedule, scope constructs.Construct, id *string, ...)
• func PipelineSchedule_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
• func PipelineSchedule_IsConstruct(x interface{}) *bool
• func PipelineSchedule_IsTerraformElement(x interface{}) *bool
• func PipelineSchedule_IsTerraformResource(x interface{}) *bool
• func PipelineSchedule_TfResourceType() *string
• type PipelineSchedule
  • func NewPipelineSchedule(scope constructs.Construct, id *string, config *PipelineScheduleConfig) PipelineSchedule
• type PipelineScheduleConfig

Functions

func NewPipelineSchedule_Override

func NewPipelineSchedule_Override(p PipelineSchedule, scope constructs.Construct, id *string, config *PipelineScheduleConfig)

Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/pipeline_schedule gitlab_pipeline_schedule} Resource.

func PipelineSchedule_GenerateConfigForImport

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

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

func PipelineSchedule_IsConstruct

func PipelineSchedule_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 PipelineSchedule_IsTerraformElement

func PipelineSchedule_IsTerraformElement(x interface{}) *bool

Experimental.

func PipelineSchedule_IsTerraformResource

func PipelineSchedule_IsTerraformResource(x interface{}) *bool

Experimental.

func PipelineSchedule_TfResourceType

func PipelineSchedule_TfResourceType() *string

Types

type PipelineSchedule

type PipelineSchedule interface {
	cdktf.TerraformResource
	Active() interface{}
	SetActive(val interface{})
	ActiveInput() interface{}
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	Cron() *string
	SetCron(val *string)
	CronInput() *string
	CronTimezone() *string
	SetCronTimezone(val *string)
	CronTimezoneInput() *string
	// 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
	Id() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	// The tree node.
	Node() constructs.Node
	Owner() *float64
	PipelineScheduleId() *float64
	Project() *string
	SetProject(val *string)
	ProjectInput() *string
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	Ref() *string
	SetRef(val *string)
	RefInput() *string
	TakeOwnership() interface{}
	SetTakeOwnership(val interface{})
	TakeOwnershipInput() interface{}
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	// 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)
	ResetActive()
	ResetCronTimezone()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetTakeOwnership()
	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.8.0/docs/resources/pipeline_schedule gitlab_pipeline_schedule}.

func NewPipelineSchedule

func NewPipelineSchedule(scope constructs.Construct, id *string, config *PipelineScheduleConfig) PipelineSchedule

Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/pipeline_schedule gitlab_pipeline_schedule} Resource.

type PipelineScheduleConfig

type PipelineScheduleConfig 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 cron (e.g. `0 1 * * *`).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/pipeline_schedule#cron PipelineSchedule#cron}
	Cron *string `field:"required" json:"cron" yaml:"cron"`
	// The description of the pipeline schedule.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/pipeline_schedule#description PipelineSchedule#description}
	Description *string `field:"required" json:"description" yaml:"description"`
	// The name or id of the project to add the schedule to.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/pipeline_schedule#project PipelineSchedule#project}
	Project *string `field:"required" json:"project" yaml:"project"`
	// The branch/tag name to be triggered. This must be the full branch reference, for example: `refs/heads/main`, not `main`.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/pipeline_schedule#ref PipelineSchedule#ref}
	Ref *string `field:"required" json:"ref" yaml:"ref"`
	// The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/pipeline_schedule#active PipelineSchedule#active}
	Active interface{} `field:"optional" json:"active" yaml:"active"`
	// The timezone.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/pipeline_schedule#cron_timezone PipelineSchedule#cron_timezone}
	CronTimezone *string `field:"optional" json:"cronTimezone" yaml:"cronTimezone"`
	// When set to `true`, the user represented by the token running Terraform will take ownership of the scheduled pipeline prior to editing it.
	//
	// This can help when managing scheduled pipeline drift when other users are making changes outside Terraform.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/pipeline_schedule#take_ownership PipelineSchedule#take_ownership}
	TakeOwnership interface{} `field:"optional" json:"takeOwnership" yaml:"takeOwnership"`
}