projectenvironment

README

gitlab_project_environment

Refer to the Terraform Registry for docs: gitlab_project_environment.

Documentation

Index

• func NewProjectEnvironment_Override(p ProjectEnvironment, scope constructs.Construct, id *string, ...)
• func ProjectEnvironment_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
• func ProjectEnvironment_IsConstruct(x interface{}) *bool
• func ProjectEnvironment_IsTerraformElement(x interface{}) *bool
• func ProjectEnvironment_IsTerraformResource(x interface{}) *bool
• func ProjectEnvironment_TfResourceType() *string
• type ProjectEnvironment
  • func NewProjectEnvironment(scope constructs.Construct, id *string, config *ProjectEnvironmentConfig) ProjectEnvironment
• type ProjectEnvironmentConfig

Functions

func NewProjectEnvironment_Override

func NewProjectEnvironment_Override(p ProjectEnvironment, scope constructs.Construct, id *string, config *ProjectEnvironmentConfig)

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

func ProjectEnvironment_GenerateConfigForImport

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

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

func ProjectEnvironment_IsConstruct

func ProjectEnvironment_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 ProjectEnvironment_IsTerraformElement

func ProjectEnvironment_IsTerraformElement(x interface{}) *bool

Experimental.

func ProjectEnvironment_IsTerraformResource

func ProjectEnvironment_IsTerraformResource(x interface{}) *bool

Experimental.

func ProjectEnvironment_TfResourceType

func ProjectEnvironment_TfResourceType() *string

Types

type ProjectEnvironment

type ProjectEnvironment interface {
	cdktf.TerraformResource
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	ClusterAgentId() *float64
	SetClusterAgentId(val *float64)
	ClusterAgentIdInput() *float64
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	CreatedAt() *string
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	ExternalUrl() *string
	SetExternalUrl(val *string)
	ExternalUrlInput() *string
	FluxResourcePath() *string
	SetFluxResourcePath(val *string)
	FluxResourcePathInput() *string
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Id() *string
	SetId(val *string)
	IdInput() *string
	KubernetesNamespace() *string
	SetKubernetesNamespace(val *string)
	KubernetesNamespaceInput() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Name() *string
	SetName(val *string)
	NameInput() *string
	// The tree node.
	Node() constructs.Node
	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{}
	Slug() *string
	State() *string
	StopBeforeDestroy() interface{}
	SetStopBeforeDestroy(val interface{})
	StopBeforeDestroyInput() interface{}
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Tier() *string
	SetTier(val *string)
	TierInput() *string
	UpdatedAt() *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)
	ResetClusterAgentId()
	ResetExternalUrl()
	ResetFluxResourcePath()
	ResetId()
	ResetKubernetesNamespace()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetStopBeforeDestroy()
	ResetTier()
	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/project_environment gitlab_project_environment}.

func NewProjectEnvironment

func NewProjectEnvironment(scope constructs.Construct, id *string, config *ProjectEnvironmentConfig) ProjectEnvironment

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

type ProjectEnvironmentConfig

type ProjectEnvironmentConfig 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 name of the environment.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/project_environment#name ProjectEnvironment#name}
	Name *string `field:"required" json:"name" yaml:"name"`
	// The ID or full path of the project to environment is created for.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/project_environment#project ProjectEnvironment#project}
	Project *string `field:"required" json:"project" yaml:"project"`
	// The cluster agent to associate with this environment.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/project_environment#cluster_agent_id ProjectEnvironment#cluster_agent_id}
	ClusterAgentId *float64 `field:"optional" json:"clusterAgentId" yaml:"clusterAgentId"`
	// Place to link to for this environment.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/project_environment#external_url ProjectEnvironment#external_url}
	ExternalUrl *string `field:"optional" json:"externalUrl" yaml:"externalUrl"`
	// The Flux resource path to associate with this environment.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/project_environment#flux_resource_path ProjectEnvironment#flux_resource_path}
	FluxResourcePath *string `field:"optional" json:"fluxResourcePath" yaml:"fluxResourcePath"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/project_environment#id ProjectEnvironment#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.
	Id *string `field:"optional" json:"id" yaml:"id"`
	// The Kubernetes namespace to associate with this environment.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/project_environment#kubernetes_namespace ProjectEnvironment#kubernetes_namespace}
	KubernetesNamespace *string `field:"optional" json:"kubernetesNamespace" yaml:"kubernetesNamespace"`
	// Determines whether the environment is attempted to be stopped before the environment is deleted.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/project_environment#stop_before_destroy ProjectEnvironment#stop_before_destroy}
	StopBeforeDestroy interface{} `field:"optional" json:"stopBeforeDestroy" yaml:"stopBeforeDestroy"`
	// The tier of the new environment. Valid values are `production`, `staging`, `testing`, `development`, `other`.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/project_environment#tier ProjectEnvironment#tier}
	Tier *string `field:"optional" json:"tier" yaml:"tier"`
}