`bigtableInstance` Submodule

Constructs

BigtableInstance

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance google_bigtable_instance}.

Initializers

using HashiCorp.Cdktf.Providers.Google;

new BigtableInstance(Construct Scope, string Id, BigtableInstanceConfig Config);

Name	Type	Description
`Scope`	`Constructs.Construct`	The scope in which to define this construct.
`Id`	`string`	The scoped construct ID.
`Config`	`BigtableInstanceConfig`	No description.

`Scope`^Required

Type: Constructs.Construct

The scope in which to define this construct.

`Id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`Config`^Required

Type: BigtableInstanceConfig

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".
`PutCluster`	No description.
`PutTimeouts`	No description.
`ResetCluster`	No description.
`ResetDeletionProtection`	No description.
`ResetDisplayName`	No description.
`ResetForceDestroy`	No description.
`ResetId`	No description.
`ResetInstanceType`	No description.
`ResetLabels`	No description.
`ResetProject`	No description.
`ResetTimeouts`	No description.

`ToString`

private string ToString()

Returns a string representation of this construct.

`AddOverride`

private void AddOverride(string Path, object Value)

`Path`^Required

Type: string

`Value`^Required

Type: object

`OverrideLogicalId`

private void OverrideLogicalId(string NewLogicalId)

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

`NewLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`ResetOverrideLogicalId`

private void ResetOverrideLogicalId()

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

`ToHclTerraform`

private object ToHclTerraform()

`ToMetadata`

private object ToMetadata()

`ToTerraform`

private object ToTerraform()

Adds this resource to the terraform JSON output.

`AddMoveTarget`

private void AddMoveTarget(string MoveTarget)

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

`MoveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`HasResourceMove`

private object HasResourceMove()

`ImportFrom`

private void ImportFrom(string Id, TerraformProvider Provider = null)

`Id`^Required

Type: string

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`MoveFromId`

private void MoveFromId(string Id)

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.

`Id`^Required

Type: string

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

`MoveTo`

private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

`MoveTarget`^Required

Type: string

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

`Index`^Optional

Type: object

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

`MoveToId`

private void MoveToId(string Id)

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

`Id`^Required

Type: string

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

`PutCluster`

private void PutCluster(object Value)

`Value`^Required

Type: object

`PutTimeouts`

private void PutTimeouts(BigtableInstanceTimeouts Value)

`Value`^Required

Type: BigtableInstanceTimeouts

`ResetCluster`

private void ResetCluster()

`ResetDeletionProtection`

private void ResetDeletionProtection()

`ResetDisplayName`

private void ResetDisplayName()

`ResetForceDestroy`

private void ResetForceDestroy()

`ResetId`

private void ResetId()

`ResetInstanceType`

private void ResetInstanceType()

`ResetLabels`

private void ResetLabels()

`ResetProject`

private void ResetProject()

`ResetTimeouts`

private void ResetTimeouts()

Static Functions

Name	Description
`IsConstruct`	Checks if `x` is a construct.
`IsTerraformElement`	No description.
`IsTerraformResource`	No description.
`GenerateConfigForImport`	Generates CDKTF code for importing a BigtableInstance resource upon running "cdktf plan ".

`IsConstruct`

using HashiCorp.Cdktf.Providers.Google;

BigtableInstance.IsConstruct(object X);

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.

`X`^Required

Type: object

Any object.

`IsTerraformElement`

using HashiCorp.Cdktf.Providers.Google;

BigtableInstance.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using HashiCorp.Cdktf.Providers.Google;

BigtableInstance.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Google;

BigtableInstance.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

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

`Scope`^Required

Type: Constructs.Construct

The scope in which to define this construct.

`ImportToId`^Required

Type: string

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

`ImportFromId`^Required

Type: string

The id of the existing BigtableInstance that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#import import section} in the documentation of this resource for the id to use

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

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

Properties

Name	Type	Description
`Node`	`Constructs.Node`	The tree node.
`CdktfStack`	`HashiCorp.Cdktf.TerraformStack`	No description.
`Fqn`	`string`	No description.
`FriendlyUniqueId`	`string`	No description.
`TerraformMetaArguments`	`System.Collections.Generic.IDictionary<string, object>`	No description.
`TerraformResourceType`	`string`	No description.
`TerraformGeneratorMetadata`	`HashiCorp.Cdktf.TerraformProviderGeneratorMetadata`	No description.
`Connection`	`object`	No description.
`Count`	`object`	No description.
`DependsOn`	`string[]`	No description.
`ForEach`	`HashiCorp.Cdktf.ITerraformIterator`	No description.
`Lifecycle`	`HashiCorp.Cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`HashiCorp.Cdktf.TerraformProvider`	No description.
`Provisioners`	`object[]`	No description.
`Cluster`	`BigtableInstanceClusterList`	No description.
`EffectiveLabels`	`HashiCorp.Cdktf.StringMap`	No description.
`TerraformLabels`	`HashiCorp.Cdktf.StringMap`	No description.
`Timeouts`	`BigtableInstanceTimeoutsOutputReference`	No description.
`ClusterInput`	`object`	No description.
`DeletionProtectionInput`	`object`	No description.
`DisplayNameInput`	`string`	No description.
`ForceDestroyInput`	`object`	No description.
`IdInput`	`string`	No description.
`InstanceTypeInput`	`string`	No description.
`LabelsInput`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`NameInput`	`string`	No description.
`ProjectInput`	`string`	No description.
`TimeoutsInput`	`object`	No description.
`DeletionProtection`	`object`	No description.
`DisplayName`	`string`	No description.
`ForceDestroy`	`object`	No description.
`Id`	`string`	No description.
`InstanceType`	`string`	No description.
`Labels`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`Name`	`string`	No description.
`Project`	`string`	No description.

`Node`^Required

public Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: HashiCorp.Cdktf.TerraformStack

`Fqn`^Required

public string Fqn { get; }

Type: string

`FriendlyUniqueId`^Required

public string FriendlyUniqueId { get; }

Type: string

`TerraformMetaArguments`^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

Type: System.Collections.Generic.IDictionary<string, object>

`TerraformResourceType`^Required

public string TerraformResourceType { get; }

Type: string

`TerraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

`Connection`^Optional

public object Connection { get; }

Type: object

`Count`^Optional

public object Count { get; }

Type: object

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; }

Type: object[]

`Cluster`^Required

public BigtableInstanceClusterList Cluster { get; }

Type: BigtableInstanceClusterList

`EffectiveLabels`^Required

public StringMap EffectiveLabels { get; }

Type: HashiCorp.Cdktf.StringMap

`TerraformLabels`^Required

public StringMap TerraformLabels { get; }

Type: HashiCorp.Cdktf.StringMap

`Timeouts`^Required

public BigtableInstanceTimeoutsOutputReference Timeouts { get; }

Type: BigtableInstanceTimeoutsOutputReference

`ClusterInput`^Optional

public object ClusterInput { get; }

Type: object

`DeletionProtectionInput`^Optional

public object DeletionProtectionInput { get; }

Type: object

`DisplayNameInput`^Optional

public string DisplayNameInput { get; }

Type: string

`ForceDestroyInput`^Optional

public object ForceDestroyInput { get; }

Type: object

`IdInput`^Optional

public string IdInput { get; }

Type: string

`InstanceTypeInput`^Optional

public string InstanceTypeInput { get; }

Type: string

`LabelsInput`^Optional

public System.Collections.Generic.IDictionary<string, string> LabelsInput { get; }

Type: System.Collections.Generic.IDictionary<string, string>

`NameInput`^Optional

public string NameInput { get; }

Type: string

`ProjectInput`^Optional

public string ProjectInput { get; }

Type: string

`TimeoutsInput`^Optional

public object TimeoutsInput { get; }

Type: object

`DeletionProtection`^Required

public object DeletionProtection { get; }

Type: object

`DisplayName`^Required

public string DisplayName { get; }

Type: string

`ForceDestroy`^Required

public object ForceDestroy { get; }

Type: object

`Id`^Required

public string Id { get; }

Type: string

`InstanceType`^Required

public string InstanceType { get; }

Type: string

`Labels`^Required

public System.Collections.Generic.IDictionary<string, string> Labels { get; }

Type: System.Collections.Generic.IDictionary<string, string>

`Name`^Required

public string Name { get; }

Type: string

`Project`^Required

public string Project { get; }

Type: string

Constants

Name	Type	Description
`TfResourceType`	`string`	No description.

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

BigtableInstanceCluster

Initializer

using HashiCorp.Cdktf.Providers.Google;

new BigtableInstanceCluster {
    string ClusterId,
    BigtableInstanceClusterAutoscalingConfig AutoscalingConfig = null,
    string KmsKeyName = null,
    double NumNodes = null,
    string StorageType = null,
    string Zone = null
};

Properties

Name	Type	Description
`ClusterId`	`string`	The ID of the Cloud Bigtable cluster.
`AutoscalingConfig`	`BigtableInstanceClusterAutoscalingConfig`	autoscaling_config block.
`KmsKeyName`	`string`	Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster.
`NumNodes`	`double`	The number of nodes in the cluster.
`StorageType`	`string`	The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".
`Zone`	`string`	The zone to create the Cloud Bigtable cluster in.

`ClusterId`^Required

public string ClusterId { get; set; }

Type: string

The ID of the Cloud Bigtable cluster.

Must be 6-30 characters and must only contain hyphens, lowercase letters and numbers.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#cluster_id BigtableInstance#cluster_id}

`AutoscalingConfig`^Optional

public BigtableInstanceClusterAutoscalingConfig AutoscalingConfig { get; set; }

Type: BigtableInstanceClusterAutoscalingConfig

autoscaling_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#autoscaling_config BigtableInstance#autoscaling_config}

`KmsKeyName`^Optional

public string KmsKeyName { get; set; }

Type: string

Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster.

The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the cloudkms.cryptoKeyEncrypterDecrypter role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. 3) All clusters within an instance must use the same CMEK key. Values are of the form projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#kms_key_name BigtableInstance#kms_key_name}

`NumNodes`^Optional

public double NumNodes { get; set; }

Type: double

The number of nodes in the cluster.

If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#num_nodes BigtableInstance#num_nodes}

`StorageType`^Optional

public string StorageType { get; set; }

Type: string

The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#storage_type BigtableInstance#storage_type}

`Zone`^Optional

public string Zone { get; set; }

Type: string

The zone to create the Cloud Bigtable cluster in.

Each cluster must have a different zone in the same region. Zones that support Bigtable instances are noted on the Cloud Bigtable locations page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#zone BigtableInstance#zone}

BigtableInstanceClusterAutoscalingConfig

Initializer

using HashiCorp.Cdktf.Providers.Google;

new BigtableInstanceClusterAutoscalingConfig {
    double CpuTarget,
    double MaxNodes,
    double MinNodes,
    double StorageTarget = null
};

Properties

Name	Type	Description
`CpuTarget`	`double`	The target CPU utilization for autoscaling. Value must be between 10 and 80.
`MaxNodes`	`double`	The maximum number of nodes for autoscaling.
`MinNodes`	`double`	The minimum number of nodes for autoscaling.
`StorageTarget`	`double`	The target storage utilization for autoscaling, in GB, for each node in a cluster.

`CpuTarget`^Required

public double CpuTarget { get; set; }

Type: double

The target CPU utilization for autoscaling. Value must be between 10 and 80.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#cpu_target BigtableInstance#cpu_target}

`MaxNodes`^Required

public double MaxNodes { get; set; }

Type: double

The maximum number of nodes for autoscaling.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#max_nodes BigtableInstance#max_nodes}

`MinNodes`^Required

public double MinNodes { get; set; }

Type: double

The minimum number of nodes for autoscaling.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#min_nodes BigtableInstance#min_nodes}

`StorageTarget`^Optional

public double StorageTarget { get; set; }

Type: double

The target storage utilization for autoscaling, in GB, for each node in a cluster.

This number is limited between 2560 (2.5TiB) and 5120 (5TiB) for a SSD cluster and between 8192 (8TiB) and 16384 (16 TiB) for an HDD cluster. If not set, whatever is already set for the cluster will not change, or if the cluster is just being created, it will use the default value of 2560 for SSD clusters and 8192 for HDD clusters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#storage_target BigtableInstance#storage_target}

BigtableInstanceConfig

Initializer

using HashiCorp.Cdktf.Providers.Google;

new BigtableInstanceConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Name,
    object Cluster = null,
    object DeletionProtection = null,
    string DisplayName = null,
    object ForceDestroy = null,
    string Id = null,
    string InstanceType = null,
    System.Collections.Generic.IDictionary<string, string> Labels = null,
    string Project = null,
    BigtableInstanceTimeouts Timeouts = null
};

Properties

Name	Type	Description
`Connection`	`object`	No description.
`Count`	`object`	No description.
`DependsOn`	`HashiCorp.Cdktf.ITerraformDependable[]`	No description.
`ForEach`	`HashiCorp.Cdktf.ITerraformIterator`	No description.
`Lifecycle`	`HashiCorp.Cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`HashiCorp.Cdktf.TerraformProvider`	No description.
`Provisioners`	`object[]`	No description.
`Name`	`string`	The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.
`Cluster`	`object`	cluster block.
`DeletionProtection`	`object`	When the field is set to true or unset in Terraform state, a terraform apply or terraform destroy that would delete the instance will fail.
`DisplayName`	`string`	The human-readable display name of the Bigtable instance. Defaults to the instance name.
`ForceDestroy`	`object`	When deleting a BigTable instance, this boolean option will delete all backups within the instance.
`Id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#id BigtableInstance#id}.
`InstanceType`	`string`	The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".
`Labels`	`System.Collections.Generic.IDictionary<string, string>`	A mapping of labels to assign to the resource.
`Project`	`string`	The ID of the project in which the resource belongs.
`Timeouts`	`BigtableInstanceTimeouts`	timeouts block.

`Connection`^Optional

public object Connection { get; set; }

Type: object

`Count`^Optional

public object Count { get; set; }

Type: object

`DependsOn`^Optional

public ITerraformDependable[] DependsOn { get; set; }

Type: HashiCorp.Cdktf.ITerraformDependable[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; set; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; set; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; set; }

Type: object[]

`Name`^Required

public string Name { get; set; }

Type: string

The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.

Must be 6-33 characters and must only contain hyphens, lowercase letters and numbers.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#name BigtableInstance#name}

`Cluster`^Optional

public object Cluster { get; set; }

Type: object

cluster block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#cluster BigtableInstance#cluster}

`DeletionProtection`^Optional

public object DeletionProtection { get; set; }

Type: object

When the field is set to true or unset in Terraform state, a terraform apply or terraform destroy that would delete the instance will fail.

When the field is set to false, deleting the instance is allowed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#deletion_protection BigtableInstance#deletion_protection}

`DisplayName`^Optional

public string DisplayName { get; set; }

Type: string

The human-readable display name of the Bigtable instance. Defaults to the instance name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#display_name BigtableInstance#display_name}

`ForceDestroy`^Optional

public object ForceDestroy { get; set; }

Type: object

When deleting a BigTable instance, this boolean option will delete all backups within the instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#force_destroy BigtableInstance#force_destroy}

`Id`^Optional

public string Id { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#id BigtableInstance#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.

`InstanceType`^Optional

public string InstanceType { get; set; }

Type: string

The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#instance_type BigtableInstance#instance_type}

`Labels`^Optional

public System.Collections.Generic.IDictionary<string, string> Labels { get; set; }

Type: System.Collections.Generic.IDictionary<string, string>

A mapping of labels to assign to the resource.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#labels BigtableInstance#labels}

`Project`^Optional

public string Project { get; set; }

Type: string

The ID of the project in which the resource belongs.

If it is not provided, the provider project is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#project BigtableInstance#project}

`Timeouts`^Optional

public BigtableInstanceTimeouts Timeouts { get; set; }

Type: BigtableInstanceTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#timeouts BigtableInstance#timeouts}

BigtableInstanceTimeouts

Initializer

using HashiCorp.Cdktf.Providers.Google;

new BigtableInstanceTimeouts {
    string Create = null,
    string Read = null,
    string Update = null
};

Properties

Name	Type	Description
`Create`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#create BigtableInstance#create}.
`Read`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#read BigtableInstance#read}.
`Update`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#update BigtableInstance#update}.

`Create`^Optional

public string Create { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#create BigtableInstance#create}.

`Read`^Optional

public string Read { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#read BigtableInstance#read}.

`Update`^Optional

public string Update { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_instance#update BigtableInstance#update}.

Classes

BigtableInstanceClusterAutoscalingConfigOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Google;

new BigtableInstanceClusterAutoscalingConfigOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`ComputeFqn`	No description.
`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.
`InterpolationForAttribute`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`ResetStorageTarget`	No description.

`ComputeFqn`

private string ComputeFqn()

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string Property)

`Property`^Required

Type: string

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetStorageTarget`

private void ResetStorageTarget()

Properties

Name	Type	Description
`CreationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`string`	No description.
`CpuTargetInput`	`double`	No description.
`MaxNodesInput`	`double`	No description.
`MinNodesInput`	`double`	No description.
`StorageTargetInput`	`double`	No description.
`CpuTarget`	`double`	No description.
`MaxNodes`	`double`	No description.
`MinNodes`	`double`	No description.
`StorageTarget`	`double`	No description.
`InternalValue`	`BigtableInstanceClusterAutoscalingConfig`	No description.

`CreationStack`^Required

public string[] CreationStack { get; }

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

public string Fqn { get; }

Type: string

`CpuTargetInput`^Optional

public double CpuTargetInput { get; }

Type: double

`MaxNodesInput`^Optional

public double MaxNodesInput { get; }

Type: double

`MinNodesInput`^Optional

public double MinNodesInput { get; }

Type: double

`StorageTargetInput`^Optional

public double StorageTargetInput { get; }

Type: double

`CpuTarget`^Required

public double CpuTarget { get; }

Type: double

`MaxNodes`^Required

public double MaxNodes { get; }

Type: double

`MinNodes`^Required

public double MinNodes { get; }

Type: double

`StorageTarget`^Required

public double StorageTarget { get; }

Type: double

`InternalValue`^Optional

public BigtableInstanceClusterAutoscalingConfig InternalValue { get; }

Type: BigtableInstanceClusterAutoscalingConfig

BigtableInstanceClusterList

Initializers

using HashiCorp.Cdktf.Providers.Google;

new BigtableInstanceClusterList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`WrapsSet`	`bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`WrapsSet`^Required

Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`AllWithMapKey`	Creating an iterator for this complex list.
`ComputeFqn`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`Get`	No description.

`AllWithMapKey`

private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`MapKeyAttributeName`^Required

Type: string

`ComputeFqn`

private string ComputeFqn()

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`Get`

private BigtableInstanceClusterOutputReference Get(double Index)

`Index`^Required

Type: double

the index of the item to return.

Properties

Name	Type	Description
`CreationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`string`	No description.
`InternalValue`	`object`	No description.

`CreationStack`^Required

public string[] CreationStack { get; }

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

public string Fqn { get; }

Type: string

`InternalValue`^Optional

public object InternalValue { get; }

Type: object

BigtableInstanceClusterOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Google;

new BigtableInstanceClusterOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`ComplexObjectIndex`	`double`	the index of this item in the list.
`ComplexObjectIsFromSet`	`bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`ComplexObjectIndex`^Required

Type: double

the index of this item in the list.

`ComplexObjectIsFromSet`^Required

Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`ComputeFqn`	No description.
`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.
`InterpolationForAttribute`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`PutAutoscalingConfig`	No description.
`ResetAutoscalingConfig`	No description.
`ResetKmsKeyName`	No description.
`ResetNumNodes`	No description.
`ResetStorageType`	No description.
`ResetZone`	No description.

`ComputeFqn`

private string ComputeFqn()

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string Property)

`Property`^Required

Type: string

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`PutAutoscalingConfig`

private void PutAutoscalingConfig(BigtableInstanceClusterAutoscalingConfig Value)

`Value`^Required

Type: BigtableInstanceClusterAutoscalingConfig

`ResetAutoscalingConfig`

private void ResetAutoscalingConfig()

`ResetKmsKeyName`

private void ResetKmsKeyName()

`ResetNumNodes`

private void ResetNumNodes()

`ResetStorageType`

private void ResetStorageType()

`ResetZone`

private void ResetZone()

Properties

Name	Type	Description
`CreationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`string`	No description.
`AutoscalingConfig`	`BigtableInstanceClusterAutoscalingConfigOutputReference`	No description.
`State`	`string`	No description.
`AutoscalingConfigInput`	`BigtableInstanceClusterAutoscalingConfig`	No description.
`ClusterIdInput`	`string`	No description.
`KmsKeyNameInput`	`string`	No description.
`NumNodesInput`	`double`	No description.
`StorageTypeInput`	`string`	No description.
`ZoneInput`	`string`	No description.
`ClusterId`	`string`	No description.
`KmsKeyName`	`string`	No description.
`NumNodes`	`double`	No description.
`StorageType`	`string`	No description.
`Zone`	`string`	No description.
`InternalValue`	`object`	No description.

`CreationStack`^Required

public string[] CreationStack { get; }

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

public string Fqn { get; }

Type: string

`AutoscalingConfig`^Required

public BigtableInstanceClusterAutoscalingConfigOutputReference AutoscalingConfig { get; }

Type: BigtableInstanceClusterAutoscalingConfigOutputReference

`State`^Required

public string State { get; }

Type: string

`AutoscalingConfigInput`^Optional

public BigtableInstanceClusterAutoscalingConfig AutoscalingConfigInput { get; }

Type: BigtableInstanceClusterAutoscalingConfig

`ClusterIdInput`^Optional

public string ClusterIdInput { get; }

Type: string

`KmsKeyNameInput`^Optional

public string KmsKeyNameInput { get; }

Type: string

`NumNodesInput`^Optional

public double NumNodesInput { get; }

Type: double

`StorageTypeInput`^Optional

public string StorageTypeInput { get; }

Type: string

`ZoneInput`^Optional

public string ZoneInput { get; }

Type: string

`ClusterId`^Required

public string ClusterId { get; }

Type: string

`KmsKeyName`^Required

public string KmsKeyName { get; }

Type: string

`NumNodes`^Required

public double NumNodes { get; }

Type: double

`StorageType`^Required

public string StorageType { get; }

Type: string

`Zone`^Required

public string Zone { get; }

Type: string

`InternalValue`^Optional

public object InternalValue { get; }

Type: object

BigtableInstanceTimeoutsOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Google;

new BigtableInstanceTimeoutsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`ComputeFqn`	No description.
`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.
`InterpolationForAttribute`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`ResetCreate`	No description.
`ResetRead`	No description.
`ResetUpdate`	No description.

`ComputeFqn`

private string ComputeFqn()

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string Property)

`Property`^Required

Type: string

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetCreate`

private void ResetCreate()

`ResetRead`

private void ResetRead()

`ResetUpdate`

private void ResetUpdate()

Properties

Name	Type	Description
`CreationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`string`	No description.
`CreateInput`	`string`	No description.
`ReadInput`	`string`	No description.
`UpdateInput`	`string`	No description.
`Create`	`string`	No description.
`Read`	`string`	No description.
`Update`	`string`	No description.
`InternalValue`	`object`	No description.

`CreationStack`^Required

public string[] CreationStack { get; }

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

public string Fqn { get; }

Type: string

`CreateInput`^Optional

public string CreateInput { get; }

Type: string

`ReadInput`^Optional

public string ReadInput { get; }

Type: string

`UpdateInput`^Optional

public string UpdateInput { get; }

Type: string

`Create`^Required

public string Create { get; }

Type: string

`Read`^Required

public string Read { get; }

Type: string

`Update`^Required

public string Update { get; }

Type: string

`InternalValue`^Optional

public object InternalValue { get; }

Type: object

Files

bigtableInstance.csharp.md

Latest commit

History

bigtableInstance.csharp.md

File metadata and controls

bigtableInstance Submodule

Constructs