`googleBigtableTable` Submodule

Constructs

GoogleBigtableTable

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

Initializers

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

new googleBigtableTable.GoogleBigtableTable(scope: Construct, id: string, config: GoogleBigtableTableConfig)

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

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".
`putAutomatedBackupPolicy`	No description.
`putColumnFamily`	No description.
`putTimeouts`	No description.
`resetAutomatedBackupPolicy`	No description.
`resetChangeStreamRetention`	No description.
`resetColumnFamily`	No description.
`resetDeletionProtection`	No description.
`resetId`	No description.
`resetProject`	No description.
`resetSplitKeys`	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".

`putAutomatedBackupPolicy`

public putAutomatedBackupPolicy(value: GoogleBigtableTableAutomatedBackupPolicy): void

`value`^Required

Type: GoogleBigtableTableAutomatedBackupPolicy

`putColumnFamily`

public putColumnFamily(value: IResolvable | GoogleBigtableTableColumnFamily[]): void

`value`^Required

Type: cdktf.IResolvable | GoogleBigtableTableColumnFamily[]

`putTimeouts`

public putTimeouts(value: GoogleBigtableTableTimeouts): void

`value`^Required

Type: GoogleBigtableTableTimeouts

`resetAutomatedBackupPolicy`

public resetAutomatedBackupPolicy(): void

`resetChangeStreamRetention`

public resetChangeStreamRetention(): void

`resetColumnFamily`

public resetColumnFamily(): void

`resetDeletionProtection`

public resetDeletionProtection(): void

`resetId`

public resetId(): void

`resetProject`

public resetProject(): void

`resetSplitKeys`

public resetSplitKeys(): 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 GoogleBigtableTable resource upon running "cdktf plan ".

`isConstruct`

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

googleBigtableTable.GoogleBigtableTable.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 { googleBigtableTable } from '@cdktf/provider-google-beta'

googleBigtableTable.GoogleBigtableTable.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

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

googleBigtableTable.GoogleBigtableTable.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

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

googleBigtableTable.GoogleBigtableTable.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`importFromId`^Required

Type: string

The id of the existing GoogleBigtableTable that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_bigtable_table#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 GoogleBigtableTable 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.
`automatedBackupPolicy`	`GoogleBigtableTableAutomatedBackupPolicyOutputReference`	No description.
`columnFamily`	`GoogleBigtableTableColumnFamilyList`	No description.
`timeouts`	`GoogleBigtableTableTimeoutsOutputReference`	No description.
`automatedBackupPolicyInput`	`GoogleBigtableTableAutomatedBackupPolicy`	No description.
`changeStreamRetentionInput`	`string`	No description.
`columnFamilyInput`	`cdktf.IResolvable \| GoogleBigtableTableColumnFamily[]`	No description.
`deletionProtectionInput`	`string`	No description.
`idInput`	`string`	No description.
`instanceNameInput`	`string`	No description.
`nameInput`	`string`	No description.
`projectInput`	`string`	No description.
`splitKeysInput`	`string[]`	No description.
`timeoutsInput`	`cdktf.IResolvable \| GoogleBigtableTableTimeouts`	No description.
`changeStreamRetention`	`string`	No description.
`deletionProtection`	`string`	No description.
`id`	`string`	No description.
`instanceName`	`string`	No description.
`name`	`string`	No description.
`project`	`string`	No description.
`splitKeys`	`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[]

`automatedBackupPolicy`^Required

public readonly automatedBackupPolicy: GoogleBigtableTableAutomatedBackupPolicyOutputReference;

Type: GoogleBigtableTableAutomatedBackupPolicyOutputReference

`columnFamily`^Required

public readonly columnFamily: GoogleBigtableTableColumnFamilyList;

Type: GoogleBigtableTableColumnFamilyList

`timeouts`^Required

public readonly timeouts: GoogleBigtableTableTimeoutsOutputReference;

Type: GoogleBigtableTableTimeoutsOutputReference

`automatedBackupPolicyInput`^Optional

public readonly automatedBackupPolicyInput: GoogleBigtableTableAutomatedBackupPolicy;

Type: GoogleBigtableTableAutomatedBackupPolicy

`changeStreamRetentionInput`^Optional

public readonly changeStreamRetentionInput: string;

Type: string

`columnFamilyInput`^Optional

public readonly columnFamilyInput: IResolvable | GoogleBigtableTableColumnFamily[];

Type: cdktf.IResolvable | GoogleBigtableTableColumnFamily[]

`deletionProtectionInput`^Optional

public readonly deletionProtectionInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`instanceNameInput`^Optional

public readonly instanceNameInput: string;

Type: string

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`projectInput`^Optional

public readonly projectInput: string;

Type: string

`splitKeysInput`^Optional

public readonly splitKeysInput: string[];

Type: string[]

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | GoogleBigtableTableTimeouts;

Type: cdktf.IResolvable | GoogleBigtableTableTimeouts

`changeStreamRetention`^Required

public readonly changeStreamRetention: string;

Type: string

`deletionProtection`^Required

public readonly deletionProtection: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`instanceName`^Required

public readonly instanceName: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`project`^Required

public readonly project: string;

Type: string

`splitKeys`^Required

public readonly splitKeys: string[];

Type: string[]

Constants

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

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

GoogleBigtableTableAutomatedBackupPolicy

Initializer

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

const googleBigtableTableAutomatedBackupPolicy: googleBigtableTable.GoogleBigtableTableAutomatedBackupPolicy = { ... }

Properties

Name	Type	Description
`frequency`	`string`	How frequently automated backups should occur.
`retentionPeriod`	`string`	How long the automated backups should be retained.

`frequency`^Optional

public readonly frequency: string;

Type: string

How frequently automated backups should occur.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_bigtable_table#frequency GoogleBigtableTable#frequency}

`retentionPeriod`^Optional

public readonly retentionPeriod: string;

Type: string

How long the automated backups should be retained.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_bigtable_table#retention_period GoogleBigtableTable#retention_period}

GoogleBigtableTableColumnFamily

Initializer

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

const googleBigtableTableColumnFamily: googleBigtableTable.GoogleBigtableTableColumnFamily = { ... }

Properties

Name	Type	Description
`family`	`string`	The name of the column family.
`type`	`string`	The type of the column family.

`family`^Required

public readonly family: string;

Type: string

The name of the column family.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_bigtable_table#family GoogleBigtableTable#family}

`type`^Optional

public readonly type: string;

Type: string

The type of the column family.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_bigtable_table#type GoogleBigtableTable#type}

GoogleBigtableTableConfig

Initializer

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

const googleBigtableTableConfig: googleBigtableTable.GoogleBigtableTableConfig = { ... }

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.
`instanceName`	`string`	The name of the Bigtable instance.
`name`	`string`	The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.
`automatedBackupPolicy`	`GoogleBigtableTableAutomatedBackupPolicy`	automated_backup_policy block.
`changeStreamRetention`	`string`	Duration to retain change stream data for the table.
`columnFamily`	`cdktf.IResolvable \| GoogleBigtableTableColumnFamily[]`	column_family block.
`deletionProtection`	`string`	A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, currently deletion protection will be set to UNPROTECTED as it is the API default value.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_bigtable_table#id GoogleBigtableTable#id}.
`project`	`string`	The ID of the project in which the resource belongs.
`splitKeys`	`string[]`	A list of predefined keys to split the table on.
`timeouts`	`GoogleBigtableTableTimeouts`	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[]

`instanceName`^Required

public readonly instanceName: string;

Type: string

The name of the Bigtable instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_bigtable_table#instance_name GoogleBigtableTable#instance_name}

`name`^Required

public readonly name: string;

Type: string

The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_bigtable_table#name GoogleBigtableTable#name}

`automatedBackupPolicy`^Optional

public readonly automatedBackupPolicy: GoogleBigtableTableAutomatedBackupPolicy;

Type: GoogleBigtableTableAutomatedBackupPolicy

automated_backup_policy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_bigtable_table#automated_backup_policy GoogleBigtableTable#automated_backup_policy}

`changeStreamRetention`^Optional

public readonly changeStreamRetention: string;

Type: string

Duration to retain change stream data for the table.

Set to 0 to disable. Must be between 1 and 7 days.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_bigtable_table#change_stream_retention GoogleBigtableTable#change_stream_retention}

`columnFamily`^Optional

public readonly columnFamily: IResolvable | GoogleBigtableTableColumnFamily[];

Type: cdktf.IResolvable | GoogleBigtableTableColumnFamily[]

column_family block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_bigtable_table#column_family GoogleBigtableTable#column_family}

`deletionProtection`^Optional

public readonly deletionProtection: string;

Type: string

A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, currently deletion protection will be set to UNPROTECTED as it is the API default value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_bigtable_table#deletion_protection GoogleBigtableTable#deletion_protection}

`id`^Optional

public readonly id: string;

Type: string

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

`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.17.0/docs/resources/google_bigtable_table#project GoogleBigtableTable#project}

`splitKeys`^Optional

public readonly splitKeys: string[];

Type: string[]

A list of predefined keys to split the table on.

!> Warning: Modifying the split_keys of an existing table will cause Terraform to delete/recreate the entire google_bigtable_table resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_bigtable_table#split_keys GoogleBigtableTable#split_keys}

`timeouts`^Optional

public readonly timeouts: GoogleBigtableTableTimeouts;

Type: GoogleBigtableTableTimeouts

timeouts block.

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

GoogleBigtableTableTimeouts

Initializer

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

const googleBigtableTableTimeouts: googleBigtableTable.GoogleBigtableTableTimeouts = { ... }

Properties

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

`create`^Optional

public readonly create: string;

Type: string

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

`update`^Optional

public readonly update: string;

Type: string

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

Classes

GoogleBigtableTableAutomatedBackupPolicyOutputReference

Initializers

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

new googleBigtableTable.GoogleBigtableTableAutomatedBackupPolicyOutputReference(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.
`resetFrequency`	No description.
`resetRetentionPeriod`	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.

`resetFrequency`

public resetFrequency(): void

`resetRetentionPeriod`

public resetRetentionPeriod(): 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.
`frequencyInput`	`string`	No description.
`retentionPeriodInput`	`string`	No description.
`frequency`	`string`	No description.
`retentionPeriod`	`string`	No description.
`internalValue`	`GoogleBigtableTableAutomatedBackupPolicy`	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

`frequencyInput`^Optional

public readonly frequencyInput: string;

Type: string

`retentionPeriodInput`^Optional

public readonly retentionPeriodInput: string;

Type: string

`frequency`^Required

public readonly frequency: string;

Type: string

`retentionPeriod`^Required

public readonly retentionPeriod: string;

Type: string

`internalValue`^Optional

public readonly internalValue: GoogleBigtableTableAutomatedBackupPolicy;

Type: GoogleBigtableTableAutomatedBackupPolicy

GoogleBigtableTableColumnFamilyList

Initializers

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

new googleBigtableTable.GoogleBigtableTableColumnFamilyList(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): GoogleBigtableTableColumnFamilyOutputReference

`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 \| GoogleBigtableTableColumnFamily[]`	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 | GoogleBigtableTableColumnFamily[];

Type: cdktf.IResolvable | GoogleBigtableTableColumnFamily[]

GoogleBigtableTableColumnFamilyOutputReference

Initializers

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

new googleBigtableTable.GoogleBigtableTableColumnFamilyOutputReference(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.
`resetType`	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.

`resetType`

public resetType(): 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.
`familyInput`	`string`	No description.
`typeInput`	`string`	No description.
`family`	`string`	No description.
`type`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| GoogleBigtableTableColumnFamily`	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

`familyInput`^Optional

public readonly familyInput: string;

Type: string

`typeInput`^Optional

public readonly typeInput: string;

Type: string

`family`^Required

public readonly family: string;

Type: string

`type`^Required

public readonly type: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | GoogleBigtableTableColumnFamily;

Type: cdktf.IResolvable | GoogleBigtableTableColumnFamily

GoogleBigtableTableTimeoutsOutputReference

Initializers

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

new googleBigtableTable.GoogleBigtableTableTimeoutsOutputReference(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.
`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

`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.
`updateInput`	`string`	No description.
`create`	`string`	No description.
`update`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| GoogleBigtableTableTimeouts`	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

`updateInput`^Optional

public readonly updateInput: string;

Type: string

`create`^Required

public readonly create: string;

Type: string

`update`^Required

public readonly update: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | GoogleBigtableTableTimeouts;

Type: cdktf.IResolvable | GoogleBigtableTableTimeouts

Files

googleBigtableTable.typescript.md

Latest commit

History

googleBigtableTable.typescript.md

File metadata and controls

googleBigtableTable Submodule

Constructs