Documentation
¶
Index ¶
- func NewProjectVariable_Override(p ProjectVariable, scope constructs.Construct, id *string, ...)
- func ProjectVariable_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func ProjectVariable_IsConstruct(x interface{}) *bool
- func ProjectVariable_IsTerraformElement(x interface{}) *bool
- func ProjectVariable_IsTerraformResource(x interface{}) *bool
- func ProjectVariable_TfResourceType() *string
- type ProjectVariable
- type ProjectVariableConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewProjectVariable_Override ¶
func NewProjectVariable_Override(p ProjectVariable, scope constructs.Construct, id *string, config *ProjectVariableConfig)
Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/project_variable gitlab_project_variable} Resource.
func ProjectVariable_GenerateConfigForImport ¶
func ProjectVariable_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a ProjectVariable resource upon running "cdktf plan <stack-name>".
func ProjectVariable_IsConstruct ¶
func ProjectVariable_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 ProjectVariable_IsTerraformElement ¶
func ProjectVariable_IsTerraformElement(x interface{}) *bool
Experimental.
func ProjectVariable_IsTerraformResource ¶
func ProjectVariable_IsTerraformResource(x interface{}) *bool
Experimental.
func ProjectVariable_TfResourceType ¶
func ProjectVariable_TfResourceType() *string
Types ¶
type ProjectVariable ¶
type ProjectVariable interface {
cdktf.TerraformResource
// 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
EnvironmentScope() *string
SetEnvironmentScope(val *string)
EnvironmentScopeInput() *string
// Experimental.
ForEach() cdktf.ITerraformIterator
// Experimental.
SetForEach(val cdktf.ITerraformIterator)
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
Id() *string
SetId(val *string)
IdInput() *string
Key() *string
SetKey(val *string)
KeyInput() *string
// Experimental.
Lifecycle() *cdktf.TerraformResourceLifecycle
// Experimental.
SetLifecycle(val *cdktf.TerraformResourceLifecycle)
Masked() interface{}
SetMasked(val interface{})
MaskedInput() interface{}
// The tree node.
Node() constructs.Node
Project() *string
SetProject(val *string)
ProjectInput() *string
Protected() interface{}
SetProtected(val interface{})
ProtectedInput() interface{}
// Experimental.
Provider() cdktf.TerraformProvider
// Experimental.
SetProvider(val cdktf.TerraformProvider)
// Experimental.
Provisioners() *[]interface{}
// Experimental.
SetProvisioners(val *[]interface{})
Raw() interface{}
SetRaw(val interface{})
RawInput() interface{}
// Experimental.
RawOverrides() interface{}
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
// Experimental.
TerraformMetaArguments() *map[string]interface{}
// Experimental.
TerraformResourceType() *string
Value() *string
SetValue(val *string)
ValueInput() *string
VariableType() *string
SetVariableType(val *string)
VariableTypeInput() *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)
ResetDescription()
ResetEnvironmentScope()
ResetId()
ResetMasked()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetProtected()
ResetRaw()
ResetVariableType()
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/project_variable gitlab_project_variable}.
func NewProjectVariable ¶
func NewProjectVariable(scope constructs.Construct, id *string, config *ProjectVariableConfig) ProjectVariable
Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/project_variable gitlab_project_variable} Resource.
type ProjectVariableConfig ¶
type ProjectVariableConfig 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 variable.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/project_variable#key ProjectVariable#key}
Key *string `field:"required" json:"key" yaml:"key"`
// The name or id of the project.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/project_variable#project ProjectVariable#project}
Project *string `field:"required" json:"project" yaml:"project"`
// The value of the variable.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/project_variable#value ProjectVariable#value}
Value *string `field:"required" json:"value" yaml:"value"`
// The description of the variable.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/project_variable#description ProjectVariable#description}
Description *string `field:"optional" json:"description" yaml:"description"`
// The environment scope of the variable.
//
// Defaults to all environment (`*`). Note that in Community Editions of Gitlab, values other than `*` will cause inconsistent plans.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/project_variable#environment_scope ProjectVariable#environment_scope}
EnvironmentScope *string `field:"optional" json:"environmentScope" yaml:"environmentScope"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/project_variable#id ProjectVariable#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"`
// If set to `true`, the value of the variable will be hidden in job logs.
//
// The value must meet the [masking requirements](https://docs.gitlab.com/ee/ci/variables/#masked-variables). Defaults to `false`.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/project_variable#masked ProjectVariable#masked}
Masked interface{} `field:"optional" json:"masked" yaml:"masked"`
// If set to `true`, the variable will be passed only to pipelines running on protected branches and tags.
//
// Defaults to `false`.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/project_variable#protected ProjectVariable#protected}
Protected interface{} `field:"optional" json:"protected" yaml:"protected"`
// Whether the variable is treated as a raw string.
//
// Default: false. When true, variables in the value are not expanded.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/project_variable#raw ProjectVariable#raw}
Raw interface{} `field:"optional" json:"raw" yaml:"raw"`
// The type of a variable. Valid values are: `env_var`, `file`. Default is `env_var`.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.8.0/docs/resources/project_variable#variable_type ProjectVariable#variable_type}
VariableType *string `field:"optional" json:"variableType" yaml:"variableType"`
}