Documentation
¶
Index ¶
- func GroupCluster_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func GroupCluster_IsConstruct(x interface{}) *bool
- func GroupCluster_IsTerraformElement(x interface{}) *bool
- func GroupCluster_IsTerraformResource(x interface{}) *bool
- func GroupCluster_TfResourceType() *string
- func NewGroupCluster_Override(g GroupCluster, scope constructs.Construct, id *string, ...)
- type GroupCluster
- type GroupClusterConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GroupCluster_GenerateConfigForImport ¶
func GroupCluster_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a GroupCluster resource upon running "cdktf plan <stack-name>".
func GroupCluster_IsConstruct ¶
func GroupCluster_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 GroupCluster_IsTerraformElement ¶
func GroupCluster_IsTerraformElement(x interface{}) *bool
Experimental.
func GroupCluster_IsTerraformResource ¶
func GroupCluster_IsTerraformResource(x interface{}) *bool
Experimental.
func GroupCluster_TfResourceType ¶
func GroupCluster_TfResourceType() *string
func NewGroupCluster_Override ¶
func NewGroupCluster_Override(g GroupCluster, scope constructs.Construct, id *string, config *GroupClusterConfig)
Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_cluster gitlab_group_cluster} Resource.
Types ¶
type GroupCluster ¶
type GroupCluster interface {
cdktf.TerraformResource
// Experimental.
CdktfStack() cdktf.TerraformStack
ClusterType() *string
// 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)
Domain() *string
SetDomain(val *string)
DomainInput() *string
Enabled() interface{}
SetEnabled(val interface{})
EnabledInput() interface{}
EnvironmentScope() *string
SetEnvironmentScope(val *string)
EnvironmentScopeInput() *string
// Experimental.
ForEach() cdktf.ITerraformIterator
// Experimental.
SetForEach(val cdktf.ITerraformIterator)
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
Group() *string
SetGroup(val *string)
GroupInput() *string
Id() *string
SetId(val *string)
IdInput() *string
KubernetesApiUrl() *string
SetKubernetesApiUrl(val *string)
KubernetesApiUrlInput() *string
KubernetesAuthorizationType() *string
SetKubernetesAuthorizationType(val *string)
KubernetesAuthorizationTypeInput() *string
KubernetesCaCert() *string
SetKubernetesCaCert(val *string)
KubernetesCaCertInput() *string
KubernetesToken() *string
SetKubernetesToken(val *string)
KubernetesTokenInput() *string
// Experimental.
Lifecycle() *cdktf.TerraformResourceLifecycle
// Experimental.
SetLifecycle(val *cdktf.TerraformResourceLifecycle)
Managed() interface{}
SetManaged(val interface{})
ManagedInput() interface{}
ManagementProjectId() *string
SetManagementProjectId(val *string)
ManagementProjectIdInput() *string
Name() *string
SetName(val *string)
NameInput() *string
// The tree node.
Node() constructs.Node
PlatformType() *string
// Experimental.
Provider() cdktf.TerraformProvider
// Experimental.
SetProvider(val cdktf.TerraformProvider)
ProviderType() *string
// Experimental.
Provisioners() *[]interface{}
// Experimental.
SetProvisioners(val *[]interface{})
// Experimental.
RawOverrides() 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)
ResetDomain()
ResetEnabled()
ResetEnvironmentScope()
ResetId()
ResetKubernetesAuthorizationType()
ResetKubernetesCaCert()
ResetManaged()
ResetManagementProjectId()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
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.0.1/docs/resources/group_cluster gitlab_group_cluster}.
func NewGroupCluster ¶
func NewGroupCluster(scope constructs.Construct, id *string, config *GroupClusterConfig) GroupCluster
Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_cluster gitlab_group_cluster} Resource.
type GroupClusterConfig ¶
type GroupClusterConfig 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 id of the group to add the cluster to.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_cluster#group GroupCluster#group}
Group *string `field:"required" json:"group" yaml:"group"`
// The URL to access the Kubernetes API.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_cluster#kubernetes_api_url GroupCluster#kubernetes_api_url}
KubernetesApiUrl *string `field:"required" json:"kubernetesApiUrl" yaml:"kubernetesApiUrl"`
// The token to authenticate against Kubernetes.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_cluster#kubernetes_token GroupCluster#kubernetes_token}
KubernetesToken *string `field:"required" json:"kubernetesToken" yaml:"kubernetesToken"`
// The name of cluster.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_cluster#name GroupCluster#name}
Name *string `field:"required" json:"name" yaml:"name"`
// The base domain of the cluster.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_cluster#domain GroupCluster#domain}
Domain *string `field:"optional" json:"domain" yaml:"domain"`
// Determines if cluster is active or not. Defaults to `true`. This attribute cannot be read.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_cluster#enabled GroupCluster#enabled}
Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
// The associated environment to the cluster. Defaults to `*`.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_cluster#environment_scope GroupCluster#environment_scope}
EnvironmentScope *string `field:"optional" json:"environmentScope" yaml:"environmentScope"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_cluster#id GroupCluster#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 cluster authorization type. Valid values are `rbac`, `abac`, `unknown_authorization`. Defaults to `rbac`.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_cluster#kubernetes_authorization_type GroupCluster#kubernetes_authorization_type}
KubernetesAuthorizationType *string `field:"optional" json:"kubernetesAuthorizationType" yaml:"kubernetesAuthorizationType"`
// TLS certificate (needed if API is using a self-signed TLS certificate).
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_cluster#kubernetes_ca_cert GroupCluster#kubernetes_ca_cert}
KubernetesCaCert *string `field:"optional" json:"kubernetesCaCert" yaml:"kubernetesCaCert"`
// Determines if cluster is managed by gitlab or not. Defaults to `true`. This attribute cannot be read.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_cluster#managed GroupCluster#managed}
Managed interface{} `field:"optional" json:"managed" yaml:"managed"`
// The ID of the management project for the cluster.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/group_cluster#management_project_id GroupCluster#management_project_id}
ManagementProjectId *string `field:"optional" json:"managementProjectId" yaml:"managementProjectId"`
}