Skip to content

Latest commit

 

History

History
1332 lines (834 loc) · 52.7 KB

instanceCluster.go.md

File metadata and controls

1332 lines (834 loc) · 52.7 KB
Raw

instanceCluster Submodule

Constructs

InstanceCluster

Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster gitlab_instance_cluster}.

Initializers 

import "github.com/cdktf/cdktf-provider-gitlab-go/gitlab/v13/instancecluster"

instancecluster.NewInstanceCluster(scope Construct, id *string, config InstanceClusterConfig) InstanceCluster
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config InstanceClusterConfig No description.
scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

idRequired
  • Type: *string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
ResetDomain No description.
ResetEnabled No description.
ResetEnvironmentScope No description.
ResetId No description.
ResetKubernetesAuthorizationType No description.
ResetKubernetesCaCert No description.
ResetKubernetesNamespace No description.
ResetManaged No description.
ResetManagementProjectId No description.
ToString 
func ToString() *string

Returns a string representation of this construct.

AddOverride 
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string
valueRequired
  • Type: interface{}
OverrideLogicalId 
func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
func ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform 
func ToHclTerraform() interface{}
ToMetadata 
func ToMetadata() interface{}
ToTerraform 
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

AddMoveTarget 
func AddMoveTarget(moveTarget *string)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: *string

The string move target that will correspond to this resource.

GetAnyMapAttribute 
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string
GetBooleanAttribute 
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
GetBooleanMapAttribute 
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string
GetListAttribute 
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string
GetNumberAttribute 
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string
GetNumberListAttribute 
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string
GetNumberMapAttribute 
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string
GetStringAttribute 
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string
GetStringMapAttribute 
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string
HasResourceMove 
func HasResourceMove() interface{}
ImportFrom 
func ImportFrom(id *string, provider TerraformProvider)
idRequired
  • Type: *string
providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
InterpolationForAttribute 
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
MoveFromId 
func MoveFromId(id *string)

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.

idRequired
  • Type: *string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

MoveTo 
func MoveTo(moveTarget *string, index interface{})

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: *string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: interface{}

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

MoveToId 
func MoveToId(id *string)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: *string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

ResetDomain 
func ResetDomain()
ResetEnabled 
func ResetEnabled()
ResetEnvironmentScope 
func ResetEnvironmentScope()
ResetId 
func ResetId()
ResetKubernetesAuthorizationType 
func ResetKubernetesAuthorizationType()
ResetKubernetesCaCert 
func ResetKubernetesCaCert()
ResetKubernetesNamespace 
func ResetKubernetesNamespace()
ResetManaged 
func ResetManaged()
ResetManagementProjectId 
func ResetManagementProjectId()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a InstanceCluster resource upon running "cdktf plan ".
IsConstruct 
import "github.com/cdktf/cdktf-provider-gitlab-go/gitlab/v13/instancecluster"

instancecluster.InstanceCluster_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.

xRequired
  • Type: interface{}

Any object.

IsTerraformElement 
import "github.com/cdktf/cdktf-provider-gitlab-go/gitlab/v13/instancecluster"

instancecluster.InstanceCluster_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}
IsTerraformResource 
import "github.com/cdktf/cdktf-provider-gitlab-go/gitlab/v13/instancecluster"

instancecluster.InstanceCluster_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}
GenerateConfigForImport 
import "github.com/cdktf/cdktf-provider-gitlab-go/gitlab/v13/instancecluster"

instancecluster.InstanceCluster_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

Generates CDKTF code for importing a InstanceCluster resource upon running "cdktf plan ".

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: *string

The construct id used in the generated config for the InstanceCluster to import.

importFromIdRequired
  • Type: *string

The id of the existing InstanceCluster that should be imported.

Refer to the {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

? Optional instance of the provider where the InstanceCluster to import is found.

Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
TerraformMetaArguments *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]*string No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
ClusterType *string No description.
CreatedAt *string No description.
PlatformType *string No description.
ProviderType *string No description.
DomainInput *string No description.
EnabledInput interface{} No description.
EnvironmentScopeInput *string No description.
IdInput *string No description.
KubernetesApiUrlInput *string No description.
KubernetesAuthorizationTypeInput *string No description.
KubernetesCaCertInput *string No description.
KubernetesNamespaceInput *string No description.
KubernetesTokenInput *string No description.
ManagedInput interface{} No description.
ManagementProjectIdInput *string No description.
NameInput *string No description.
Domain *string No description.
Enabled interface{} No description.
EnvironmentScope *string No description.
Id *string No description.
KubernetesApiUrl *string No description.
KubernetesAuthorizationType *string No description.
KubernetesCaCert *string No description.
KubernetesNamespace *string No description.
KubernetesToken *string No description.
Managed interface{} No description.
ManagementProjectId *string No description.
Name *string No description.
NodeRequired 
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

CdktfStackRequired 
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack
FqnRequired 
func Fqn() *string
  • Type: *string
FriendlyUniqueIdRequired 
func FriendlyUniqueId() *string
  • Type: *string
TerraformMetaArgumentsRequired 
func TerraformMetaArguments() *map[string]interface{}
  • Type: *map[string]interface{}
TerraformResourceTypeRequired 
func TerraformResourceType() *string
  • Type: *string
TerraformGeneratorMetadataOptional 
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata
ConnectionOptional 
func Connection() interface{}
  • Type: interface{}
CountOptional 
func Count() interface{}
  • Type: interface{}
DependsOnOptional 
func DependsOn() *[]*string
  • Type: *[]*string
ForEachOptional 
func ForEach() ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
func Lifecycle() TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
func Provider() TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
ProvisionersOptional 
func Provisioners() *[]interface{}
  • Type: *[]interface{}
ClusterTypeRequired 
func ClusterType() *string
  • Type: *string
CreatedAtRequired 
func CreatedAt() *string
  • Type: *string
PlatformTypeRequired 
func PlatformType() *string
  • Type: *string
ProviderTypeRequired 
func ProviderType() *string
  • Type: *string
DomainInputOptional 
func DomainInput() *string
  • Type: *string
EnabledInputOptional 
func EnabledInput() interface{}
  • Type: interface{}
EnvironmentScopeInputOptional 
func EnvironmentScopeInput() *string
  • Type: *string
IdInputOptional 
func IdInput() *string
  • Type: *string
KubernetesApiUrlInputOptional 
func KubernetesApiUrlInput() *string
  • Type: *string
KubernetesAuthorizationTypeInputOptional 
func KubernetesAuthorizationTypeInput() *string
  • Type: *string
KubernetesCaCertInputOptional 
func KubernetesCaCertInput() *string
  • Type: *string
KubernetesNamespaceInputOptional 
func KubernetesNamespaceInput() *string
  • Type: *string
KubernetesTokenInputOptional 
func KubernetesTokenInput() *string
  • Type: *string
ManagedInputOptional 
func ManagedInput() interface{}
  • Type: interface{}
ManagementProjectIdInputOptional 
func ManagementProjectIdInput() *string
  • Type: *string
NameInputOptional 
func NameInput() *string
  • Type: *string
DomainRequired 
func Domain() *string
  • Type: *string
EnabledRequired 
func Enabled() interface{}
  • Type: interface{}
EnvironmentScopeRequired 
func EnvironmentScope() *string
  • Type: *string
IdRequired 
func Id() *string
  • Type: *string
KubernetesApiUrlRequired 
func KubernetesApiUrl() *string
  • Type: *string
KubernetesAuthorizationTypeRequired 
func KubernetesAuthorizationType() *string
  • Type: *string
KubernetesCaCertRequired 
func KubernetesCaCert() *string
  • Type: *string
KubernetesNamespaceRequired 
func KubernetesNamespace() *string
  • Type: *string
KubernetesTokenRequired 
func KubernetesToken() *string
  • Type: *string
ManagedRequired 
func Managed() interface{}
  • Type: interface{}
ManagementProjectIdRequired 
func ManagementProjectId() *string
  • Type: *string
NameRequired 
func Name() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.
TfResourceTypeRequired 
func TfResourceType() *string
  • Type: *string

Structs

InstanceClusterConfig

Initializer 

import "github.com/cdktf/cdktf-provider-gitlab-go/gitlab/v13/instancecluster"

&instancecluster.InstanceClusterConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	KubernetesApiUrl: *string,
	KubernetesToken: *string,
	Name: *string,
	Domain: *string,
	Enabled: interface{},
	EnvironmentScope: *string,
	Id: *string,
	KubernetesAuthorizationType: *string,
	KubernetesCaCert: *string,
	KubernetesNamespace: *string,
	Managed: interface{},
	ManagementProjectId: *string,
}

Properties

Name Type Description
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
KubernetesApiUrl *string The URL to access the Kubernetes API.
KubernetesToken *string The token to authenticate against Kubernetes. This attribute cannot be read.
Name *string The name of cluster.
Domain *string The base domain of the cluster.
Enabled interface{} Determines if cluster is active or not. Defaults to true. This attribute cannot be read.
EnvironmentScope *string The associated environment to the cluster. Defaults to *.
Id *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#id InstanceCluster#id}.
KubernetesAuthorizationType *string The cluster authorization type. Valid values are rbac, abac, unknown_authorization. Defaults to rbac.
KubernetesCaCert *string TLS certificate (needed if API is using a self-signed TLS certificate).
KubernetesNamespace *string The unique namespace related to the instance.
Managed interface{} Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.
ManagementProjectId *string The ID of the management project for the cluster.
ConnectionOptional 
Connection interface{}
  • Type: interface{}
CountOptional 
Count interface{}
  • Type: interface{}
DependsOnOptional 
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable
ForEachOptional 
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
ProvisionersOptional 
Provisioners *[]interface{}
  • Type: *[]interface{}
KubernetesApiUrlRequired 
KubernetesApiUrl *string
  • Type: *string

The URL to access the Kubernetes API.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#kubernetes_api_url InstanceCluster#kubernetes_api_url}

KubernetesTokenRequired 
KubernetesToken *string
  • Type: *string

The token to authenticate against Kubernetes. This attribute cannot be read.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#kubernetes_token InstanceCluster#kubernetes_token}

NameRequired 
Name *string
  • Type: *string

The name of cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#name InstanceCluster#name}

DomainOptional 
Domain *string
  • Type: *string

The base domain of the cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#domain InstanceCluster#domain}

EnabledOptional 
Enabled interface{}
  • Type: interface{}

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.6.1/docs/resources/instance_cluster#enabled InstanceCluster#enabled}

EnvironmentScopeOptional 
EnvironmentScope *string
  • Type: *string

The associated environment to the cluster. Defaults to *.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#environment_scope InstanceCluster#environment_scope}

IdOptional 
Id *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#id InstanceCluster#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.

KubernetesAuthorizationTypeOptional 
KubernetesAuthorizationType *string
  • Type: *string

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.6.1/docs/resources/instance_cluster#kubernetes_authorization_type InstanceCluster#kubernetes_authorization_type}

KubernetesCaCertOptional 
KubernetesCaCert *string
  • Type: *string

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.6.1/docs/resources/instance_cluster#kubernetes_ca_cert InstanceCluster#kubernetes_ca_cert}

KubernetesNamespaceOptional 
KubernetesNamespace *string
  • Type: *string

The unique namespace related to the instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#kubernetes_namespace InstanceCluster#kubernetes_namespace}

ManagedOptional 
Managed interface{}
  • Type: interface{}

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.6.1/docs/resources/instance_cluster#managed InstanceCluster#managed}

ManagementProjectIdOptional 
ManagementProjectId *string
  • Type: *string

The ID of the management project for the cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/instance_cluster#management_project_id InstanceCluster#management_project_id}