`googleBigtableInstance` Submodule

Constructs

GoogleBigtableInstance

Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.16.0/docs/resources/google_bigtable_instance google_bigtable_instance}.

Initializers

import { googleBigtableInstance } from '@cdktf/provider-google-beta'

new googleBigtableInstance.GoogleBigtableInstance(scope: Construct, id: string, config: GoogleBigtableInstanceConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`GoogleBigtableInstanceConfig`	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: GoogleBigtableInstanceConfig

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`

public toString(): string

Returns a string representation of this construct.

`addOverride`

public addOverride(path: string, value: any): void

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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`

public resetOverrideLogicalId(): void

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

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

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`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

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`

public moveTo(moveTarget: string, index?: string | number): void

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: string | number

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

`moveToId`

public moveToId(id: string): void

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`

public putCluster(value: IResolvable | GoogleBigtableInstanceCluster[]): void

`value`^Required

Type: cdktf.IResolvable | GoogleBigtableInstanceCluster[]

`putTimeouts`

public putTimeouts(value: GoogleBigtableInstanceTimeouts): void

`value`^Required

Type: GoogleBigtableInstanceTimeouts

`resetCluster`

public resetCluster(): void

`resetDeletionProtection`

public resetDeletionProtection(): void

`resetDisplayName`

public resetDisplayName(): void

`resetForceDestroy`

public resetForceDestroy(): void

`resetId`

public resetId(): void

`resetInstanceType`

public resetInstanceType(): void

`resetLabels`

public resetLabels(): void

`resetProject`

public resetProject(): void

`resetTimeouts`

public resetTimeouts(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformResource`	No description.
`generateConfigForImport`	Generates CDKTF code for importing a GoogleBigtableInstance resource upon running "cdktf plan ".

`isConstruct`

import { googleBigtableInstance } from '@cdktf/provider-google-beta'

googleBigtableInstance.GoogleBigtableInstance.isConstruct(x: any)

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: any

Any object.

`isTerraformElement`

import { googleBigtableInstance } from '@cdktf/provider-google-beta'

googleBigtableInstance.GoogleBigtableInstance.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { googleBigtableInstance } from '@cdktf/provider-google-beta'

googleBigtableInstance.GoogleBigtableInstance.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { googleBigtableInstance } from '@cdktf/provider-google-beta'

googleBigtableInstance.GoogleBigtableInstance.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a GoogleBigtableInstance 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 GoogleBigtableInstance to import.

`importFromId`^Required

Type: string

The id of the existing GoogleBigtableInstance that should be imported.

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

`provider`^Optional

Type: cdktf.TerraformProvider

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

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktfStack`	`cdktf.TerraformStack`	No description.
`fqn`	`string`	No description.
`friendlyUniqueId`	`string`	No description.
`terraformMetaArguments`	`{[ key: string ]: any}`	No description.
`terraformResourceType`	`string`	No description.
`terraformGeneratorMetadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`string[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`cluster`	`GoogleBigtableInstanceClusterList`	No description.
`effectiveLabels`	`cdktf.StringMap`	No description.
`terraformLabels`	`cdktf.StringMap`	No description.
`timeouts`	`GoogleBigtableInstanceTimeoutsOutputReference`	No description.
`clusterInput`	`cdktf.IResolvable \| GoogleBigtableInstanceCluster[]`	No description.
`deletionProtectionInput`	`boolean \| cdktf.IResolvable`	No description.
`displayNameInput`	`string`	No description.
`forceDestroyInput`	`boolean \| cdktf.IResolvable`	No description.
`idInput`	`string`	No description.
`instanceTypeInput`	`string`	No description.
`labelsInput`	`{[ key: string ]: string}`	No description.
`nameInput`	`string`	No description.
`projectInput`	`string`	No description.
`timeoutsInput`	`cdktf.IResolvable \| GoogleBigtableInstanceTimeouts`	No description.
`deletionProtection`	`boolean \| cdktf.IResolvable`	No description.
`displayName`	`string`	No description.
`forceDestroy`	`boolean \| cdktf.IResolvable`	No description.
`id`	`string`	No description.
`instanceType`	`string`	No description.
`labels`	`{[ key: string ]: string}`	No description.
`name`	`string`	No description.
`project`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`cluster`^Required

public readonly cluster: GoogleBigtableInstanceClusterList;

Type: GoogleBigtableInstanceClusterList

`effectiveLabels`^Required

public readonly effectiveLabels: StringMap;

Type: cdktf.StringMap

`terraformLabels`^Required

public readonly terraformLabels: StringMap;

Type: cdktf.StringMap

`timeouts`^Required

public readonly timeouts: GoogleBigtableInstanceTimeoutsOutputReference;

Type: GoogleBigtableInstanceTimeoutsOutputReference

`clusterInput`^Optional

public readonly clusterInput: IResolvable | GoogleBigtableInstanceCluster[];

Type: cdktf.IResolvable | GoogleBigtableInstanceCluster[]

`deletionProtectionInput`^Optional

public readonly deletionProtectionInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`displayNameInput`^Optional

public readonly displayNameInput: string;

Type: string

`forceDestroyInput`^Optional

public readonly forceDestroyInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`idInput`^Optional

public readonly idInput: string;

Type: string

`instanceTypeInput`^Optional

public readonly instanceTypeInput: string;

Type: string

`labelsInput`^Optional

public readonly labelsInput: {[ key: string ]: string};

Type: {[ key: string ]: string}

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`projectInput`^Optional

public readonly projectInput: string;

Type: string

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | GoogleBigtableInstanceTimeouts;

Type: cdktf.IResolvable | GoogleBigtableInstanceTimeouts

`deletionProtection`^Required

public readonly deletionProtection: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`displayName`^Required

public readonly displayName: string;

Type: string

`forceDestroy`^Required

public readonly forceDestroy: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`id`^Required

public readonly id: string;

Type: string

`instanceType`^Required

public readonly instanceType: string;

Type: string

`labels`^Required

public readonly labels: {[ key: string ]: string};

Type: {[ key: string ]: string}

`name`^Required

public readonly name: string;

Type: string

`project`^Required

public readonly project: string;

Type: string

Constants

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

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

GoogleBigtableInstanceCluster

Initializer

import { googleBigtableInstance } from '@cdktf/provider-google-beta'

const googleBigtableInstanceCluster: googleBigtableInstance.GoogleBigtableInstanceCluster = { ... }

Properties

Name	Type	Description
`clusterId`	`string`	The ID of the Cloud Bigtable cluster.
`autoscalingConfig`	`GoogleBigtableInstanceClusterAutoscalingConfig`	autoscaling_config block.
`kmsKeyName`	`string`	Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster.
`numNodes`	`number`	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 readonly clusterId: string;

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-beta/6.16.0/docs/resources/google_bigtable_instance#cluster_id GoogleBigtableInstance#cluster_id}

`autoscalingConfig`^Optional

public readonly autoscalingConfig: GoogleBigtableInstanceClusterAutoscalingConfig;

Type: GoogleBigtableInstanceClusterAutoscalingConfig

autoscaling_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.16.0/docs/resources/google_bigtable_instance#autoscaling_config GoogleBigtableInstance#autoscaling_config}

`kmsKeyName`^Optional

public readonly kmsKeyName: string;

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-beta/6.16.0/docs/resources/google_bigtable_instance#kms_key_name GoogleBigtableInstance#kms_key_name}

`numNodes`^Optional

public readonly numNodes: number;

Type: number

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-beta/6.16.0/docs/resources/google_bigtable_instance#num_nodes GoogleBigtableInstance#num_nodes}

`storageType`^Optional

public readonly storageType: string;

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-beta/6.16.0/docs/resources/google_bigtable_instance#storage_type GoogleBigtableInstance#storage_type}

`zone`^Optional

public readonly zone: string;

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-beta/6.16.0/docs/resources/google_bigtable_instance#zone GoogleBigtableInstance#zone}

GoogleBigtableInstanceClusterAutoscalingConfig

Initializer

import { googleBigtableInstance } from '@cdktf/provider-google-beta'

const googleBigtableInstanceClusterAutoscalingConfig: googleBigtableInstance.GoogleBigtableInstanceClusterAutoscalingConfig = { ... }

Properties

Name	Type	Description
`cpuTarget`	`number`	The target CPU utilization for autoscaling. Value must be between 10 and 80.
`maxNodes`	`number`	The maximum number of nodes for autoscaling.
`minNodes`	`number`	The minimum number of nodes for autoscaling.
`storageTarget`	`number`	The target storage utilization for autoscaling, in GB, for each node in a cluster.

`cpuTarget`^Required

public readonly cpuTarget: number;

Type: number

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-beta/6.16.0/docs/resources/google_bigtable_instance#cpu_target GoogleBigtableInstance#cpu_target}

`maxNodes`^Required

public readonly maxNodes: number;

Type: number

The maximum number of nodes for autoscaling.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.16.0/docs/resources/google_bigtable_instance#max_nodes GoogleBigtableInstance#max_nodes}

`minNodes`^Required

public readonly minNodes: number;

Type: number

The minimum number of nodes for autoscaling.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.16.0/docs/resources/google_bigtable_instance#min_nodes GoogleBigtableInstance#min_nodes}

`storageTarget`^Optional

public readonly storageTarget: number;

Type: number

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-beta/6.16.0/docs/resources/google_bigtable_instance#storage_target GoogleBigtableInstance#storage_target}

GoogleBigtableInstanceConfig

Initializer

import { googleBigtableInstance } from '@cdktf/provider-google-beta'

const googleBigtableInstanceConfig: googleBigtableInstance.GoogleBigtableInstanceConfig = { ... }

Properties

Name	Type	Description
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`cdktf.ITerraformDependable[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`name`	`string`	The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.
`cluster`	`cdktf.IResolvable \| GoogleBigtableInstanceCluster[]`	cluster block.
`deletionProtection`	`boolean \| cdktf.IResolvable`	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`	`boolean \| cdktf.IResolvable`	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-beta/6.16.0/docs/resources/google_bigtable_instance#id GoogleBigtableInstance#id}.
`instanceType`	`string`	The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".
`labels`	`{[ key: string ]: string}`	A mapping of labels to assign to the resource.
`project`	`string`	The ID of the project in which the resource belongs.
`timeouts`	`GoogleBigtableInstanceTimeouts`	timeouts block.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`name`^Required

public readonly name: string;

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-beta/6.16.0/docs/resources/google_bigtable_instance#name GoogleBigtableInstance#name}

`cluster`^Optional

public readonly cluster: IResolvable | GoogleBigtableInstanceCluster[];

Type: cdktf.IResolvable | GoogleBigtableInstanceCluster[]

cluster block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.16.0/docs/resources/google_bigtable_instance#cluster GoogleBigtableInstance#cluster}

`deletionProtection`^Optional

public readonly deletionProtection: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

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-beta/6.16.0/docs/resources/google_bigtable_instance#deletion_protection GoogleBigtableInstance#deletion_protection}

`displayName`^Optional

public readonly displayName: string;

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-beta/6.16.0/docs/resources/google_bigtable_instance#display_name GoogleBigtableInstance#display_name}

`forceDestroy`^Optional

public readonly forceDestroy: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

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-beta/6.16.0/docs/resources/google_bigtable_instance#force_destroy GoogleBigtableInstance#force_destroy}

`id`^Optional

public readonly id: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.16.0/docs/resources/google_bigtable_instance#id GoogleBigtableInstance#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 readonly instanceType: string;

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-beta/6.16.0/docs/resources/google_bigtable_instance#instance_type GoogleBigtableInstance#instance_type}

`labels`^Optional

public readonly labels: {[ key: string ]: string};

Type: {[ key: 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-beta/6.16.0/docs/resources/google_bigtable_instance#labels GoogleBigtableInstance#labels}

`project`^Optional

public readonly project: string;

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-beta/6.16.0/docs/resources/google_bigtable_instance#project GoogleBigtableInstance#project}

`timeouts`^Optional

public readonly timeouts: GoogleBigtableInstanceTimeouts;

Type: GoogleBigtableInstanceTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.16.0/docs/resources/google_bigtable_instance#timeouts GoogleBigtableInstance#timeouts}

GoogleBigtableInstanceTimeouts

Initializer

import { googleBigtableInstance } from '@cdktf/provider-google-beta'

const googleBigtableInstanceTimeouts: googleBigtableInstance.GoogleBigtableInstanceTimeouts = { ... }

Properties

Name	Type	Description
`create`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.16.0/docs/resources/google_bigtable_instance#create GoogleBigtableInstance#create}.
`read`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.16.0/docs/resources/google_bigtable_instance#read GoogleBigtableInstance#read}.
`update`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.16.0/docs/resources/google_bigtable_instance#update GoogleBigtableInstance#update}.

`create`^Optional

public readonly create: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.16.0/docs/resources/google_bigtable_instance#create GoogleBigtableInstance#create}.

`read`^Optional

public readonly read: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.16.0/docs/resources/google_bigtable_instance#read GoogleBigtableInstance#read}.

`update`^Optional

public readonly update: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.16.0/docs/resources/google_bigtable_instance#update GoogleBigtableInstance#update}.

Classes

GoogleBigtableInstanceClusterAutoscalingConfigOutputReference

Initializers

import { googleBigtableInstance } from '@cdktf/provider-google-beta'

new googleBigtableInstance.GoogleBigtableInstanceClusterAutoscalingConfigOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: 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`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetStorageTarget`

public resetStorageTarget(): void

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`	`number`	No description.
`maxNodesInput`	`number`	No description.
`minNodesInput`	`number`	No description.
`storageTargetInput`	`number`	No description.
`cpuTarget`	`number`	No description.
`maxNodes`	`number`	No description.
`minNodes`	`number`	No description.
`storageTarget`	`number`	No description.
`internalValue`	`GoogleBigtableInstanceClusterAutoscalingConfig`	No description.

`creationStack`^Required

public readonly creationStack: string[];

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 readonly fqn: string;

Type: string

`cpuTargetInput`^Optional

public readonly cpuTargetInput: number;

Type: number

`maxNodesInput`^Optional

public readonly maxNodesInput: number;

Type: number

`minNodesInput`^Optional

public readonly minNodesInput: number;

Type: number

`storageTargetInput`^Optional

public readonly storageTargetInput: number;

Type: number

`cpuTarget`^Required

public readonly cpuTarget: number;

Type: number

`maxNodes`^Required

public readonly maxNodes: number;

Type: number

`minNodes`^Required

public readonly minNodes: number;

Type: number

`storageTarget`^Required

public readonly storageTarget: number;

Type: number

`internalValue`^Optional

public readonly internalValue: GoogleBigtableInstanceClusterAutoscalingConfig;

Type: GoogleBigtableInstanceClusterAutoscalingConfig

GoogleBigtableInstanceClusterList

Initializers

import { googleBigtableInstance } from '@cdktf/provider-google-beta'

new googleBigtableInstance.GoogleBigtableInstanceClusterList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`wrapsSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`wrapsSet`^Required

Type: boolean

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`

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

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`

public computeFqn(): string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`get`

public get(index: number): GoogleBigtableInstanceClusterOutputReference

`index`^Required

Type: number

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`	`cdktf.IResolvable \| GoogleBigtableInstanceCluster[]`	No description.

`creationStack`^Required

public readonly creationStack: string[];

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 readonly fqn: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | GoogleBigtableInstanceCluster[];

Type: cdktf.IResolvable | GoogleBigtableInstanceCluster[]

GoogleBigtableInstanceClusterOutputReference

Initializers

import { googleBigtableInstance } from '@cdktf/provider-google-beta'

new googleBigtableInstance.GoogleBigtableInstanceClusterOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`complexObjectIndex`	`number`	the index of this item in the list.
`complexObjectIsFromSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`complexObjectIndex`^Required

Type: number

the index of this item in the list.

`complexObjectIsFromSet`^Required

Type: boolean

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`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`putAutoscalingConfig`

public putAutoscalingConfig(value: GoogleBigtableInstanceClusterAutoscalingConfig): void

`value`^Required

Type: GoogleBigtableInstanceClusterAutoscalingConfig

`resetAutoscalingConfig`

public resetAutoscalingConfig(): void

`resetKmsKeyName`

public resetKmsKeyName(): void

`resetNumNodes`

public resetNumNodes(): void

`resetStorageType`

public resetStorageType(): void

`resetZone`

public resetZone(): void

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`	`GoogleBigtableInstanceClusterAutoscalingConfigOutputReference`	No description.
`state`	`string`	No description.
`autoscalingConfigInput`	`GoogleBigtableInstanceClusterAutoscalingConfig`	No description.
`clusterIdInput`	`string`	No description.
`kmsKeyNameInput`	`string`	No description.
`numNodesInput`	`number`	No description.
`storageTypeInput`	`string`	No description.
`zoneInput`	`string`	No description.
`clusterId`	`string`	No description.
`kmsKeyName`	`string`	No description.
`numNodes`	`number`	No description.
`storageType`	`string`	No description.
`zone`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| GoogleBigtableInstanceCluster`	No description.

`creationStack`^Required

public readonly creationStack: string[];

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 readonly fqn: string;

Type: string

`autoscalingConfig`^Required

public readonly autoscalingConfig: GoogleBigtableInstanceClusterAutoscalingConfigOutputReference;

Type: GoogleBigtableInstanceClusterAutoscalingConfigOutputReference

`state`^Required

public readonly state: string;

Type: string

`autoscalingConfigInput`^Optional

public readonly autoscalingConfigInput: GoogleBigtableInstanceClusterAutoscalingConfig;

Type: GoogleBigtableInstanceClusterAutoscalingConfig

`clusterIdInput`^Optional

public readonly clusterIdInput: string;

Type: string

`kmsKeyNameInput`^Optional

public readonly kmsKeyNameInput: string;

Type: string

`numNodesInput`^Optional

public readonly numNodesInput: number;

Type: number

`storageTypeInput`^Optional

public readonly storageTypeInput: string;

Type: string

`zoneInput`^Optional

public readonly zoneInput: string;

Type: string

`clusterId`^Required

public readonly clusterId: string;

Type: string

`kmsKeyName`^Required

public readonly kmsKeyName: string;

Type: string

`numNodes`^Required

public readonly numNodes: number;

Type: number

`storageType`^Required

public readonly storageType: string;

Type: string

`zone`^Required

public readonly zone: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | GoogleBigtableInstanceCluster;

Type: cdktf.IResolvable | GoogleBigtableInstanceCluster

GoogleBigtableInstanceTimeoutsOutputReference

Initializers

import { googleBigtableInstance } from '@cdktf/provider-google-beta'

new googleBigtableInstance.GoogleBigtableInstanceTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: 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`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetCreate`

public resetCreate(): void

`resetRead`

public resetRead(): void

`resetUpdate`

public resetUpdate(): void

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`	`cdktf.IResolvable \| GoogleBigtableInstanceTimeouts`	No description.

`creationStack`^Required

public readonly creationStack: string[];

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 readonly fqn: string;

Type: string

`createInput`^Optional

public readonly createInput: string;

Type: string

`readInput`^Optional

public readonly readInput: string;

Type: string

`updateInput`^Optional

public readonly updateInput: string;

Type: string

`create`^Required

public readonly create: string;

Type: string

`read`^Required

public readonly read: string;

Type: string

`update`^Required

public readonly update: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | GoogleBigtableInstanceTimeouts;

Type: cdktf.IResolvable | GoogleBigtableInstanceTimeouts

Files

googleBigtableInstance.typescript.md

Latest commit

History

googleBigtableInstance.typescript.md

File metadata and controls

googleBigtableInstance Submodule

Constructs