Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table google_bigtable_table}.
import com.hashicorp.cdktf.providers.google.bigtable_table.BigtableTable;
BigtableTable.Builder.create(Construct scope, java.lang.String id)
// .connection(SSHProvisionerConnection)
// .connection(WinrmProvisionerConnection)
// .count(java.lang.Number)
// .count(TerraformCount)
// .dependsOn(java.util.List<ITerraformDependable>)
// .forEach(ITerraformIterator)
// .lifecycle(TerraformResourceLifecycle)
// .provider(TerraformProvider)
// .provisioners(java.util.List<FileProvisioner)
// .provisioners(LocalExecProvisioner)
// .provisioners(RemoteExecProvisioner>)
.instanceName(java.lang.String)
.name(java.lang.String)
// .automatedBackupPolicy(BigtableTableAutomatedBackupPolicy)
// .changeStreamRetention(java.lang.String)
// .columnFamily(IResolvable)
// .columnFamily(java.util.List<BigtableTableColumnFamily>)
// .deletionProtection(java.lang.String)
// .id(java.lang.String)
// .project(java.lang.String)
// .splitKeys(java.util.List<java.lang.String>)
// .timeouts(BigtableTableTimeouts)
.build();
Name | Type | Description |
---|---|---|
scope |
software.constructs.Construct |
The scope in which to define this construct. |
id |
java.lang.String |
The scoped construct ID. |
connection |
com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection |
No description. |
count |
java.lang.Number OR com.hashicorp.cdktf.TerraformCount |
No description. |
dependsOn |
java.util.List<com.hashicorp.cdktf.ITerraformDependable> |
No description. |
forEach |
com.hashicorp.cdktf.ITerraformIterator |
No description. |
lifecycle |
com.hashicorp.cdktf.TerraformResourceLifecycle |
No description. |
provider |
com.hashicorp.cdktf.TerraformProvider |
No description. |
provisioners |
java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> |
No description. |
instanceName |
java.lang.String |
The name of the Bigtable instance. |
name |
java.lang.String |
The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers. |
automatedBackupPolicy |
BigtableTableAutomatedBackupPolicy |
automated_backup_policy block. |
changeStreamRetention |
java.lang.String |
Duration to retain change stream data for the table. |
columnFamily |
com.hashicorp.cdktf.IResolvable OR java.util.List<BigtableTableColumnFamily> |
column_family block. |
deletionProtection |
java.lang.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 |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#id BigtableTable#id}. |
project |
java.lang.String |
The ID of the project in which the resource belongs. |
splitKeys |
java.util.List<java.lang.String> |
A list of predefined keys to split the table on. |
timeouts |
BigtableTableTimeouts |
timeouts block. |
- Type: software.constructs.Construct
The scope in which to define this construct.
- Type: java.lang.String
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
- Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
- Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
- Type: com.hashicorp.cdktf.ITerraformIterator
- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
- Type: com.hashicorp.cdktf.TerraformProvider
- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
- Type: java.lang.String
The name of the Bigtable instance.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#instance_name BigtableTable#instance_name}
- Type: java.lang.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/6.17.0/docs/resources/bigtable_table#name BigtableTable#name}
automated_backup_policy block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#automated_backup_policy BigtableTable#automated_backup_policy}
- Type: java.lang.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/6.17.0/docs/resources/bigtable_table#change_stream_retention BigtableTable#change_stream_retention}
- Type: com.hashicorp.cdktf.IResolvable OR java.util.List<BigtableTableColumnFamily>
column_family block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#column_family BigtableTable#column_family}
- Type: java.lang.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/6.17.0/docs/resources/bigtable_table#deletion_protection BigtableTable#deletion_protection}
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#id BigtableTable#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.
- Type: java.lang.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.17.0/docs/resources/bigtable_table#project BigtableTable#project}
- Type: java.util.List<java.lang.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/6.17.0/docs/resources/bigtable_table#split_keys BigtableTable#split_keys}
- Type: BigtableTableTimeouts
timeouts block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#timeouts BigtableTable#timeouts}
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. |
public java.lang.String toString()
Returns a string representation of this construct.
public void addOverride(java.lang.String path, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
public void overrideLogicalId(java.lang.String newLogicalId)
Overrides the auto-generated logical ID with a specific ID.
- Type: java.lang.String
The new logical ID to use for this stack element.
public void resetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
public java.lang.Object toHclTerraform()
public java.lang.Object toMetadata()
public java.lang.Object toTerraform()
Adds this resource to the terraform JSON output.
public void addMoveTarget(java.lang.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.
- Type: java.lang.String
The string move target that will correspond to this resource.
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
- Type: java.lang.String
- Type: com.hashicorp.cdktf.TerraformProvider
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public void moveFromId(java.lang.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.
- Type: java.lang.String
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)
Moves this resource to the target resource given by moveTarget.
- Type: java.lang.String
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: java.lang.String OR java.lang.Number
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
public void moveToId(java.lang.String id)
Moves this resource to the resource corresponding to "id".
- Type: java.lang.String
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public void putAutomatedBackupPolicy(BigtableTableAutomatedBackupPolicy value)
public void putColumnFamily(IResolvable OR java.util.List<BigtableTableColumnFamily> value)
- Type: com.hashicorp.cdktf.IResolvable OR java.util.List<BigtableTableColumnFamily>
public void putTimeouts(BigtableTableTimeouts value)
- Type: BigtableTableTimeouts
public void resetAutomatedBackupPolicy()
public void resetChangeStreamRetention()
public void resetColumnFamily()
public void resetDeletionProtection()
public void resetId()
public void resetProject()
public void resetSplitKeys()
public void resetTimeouts()
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a BigtableTable resource upon running "cdktf plan ". |
import com.hashicorp.cdktf.providers.google.bigtable_table.BigtableTable;
BigtableTable.isConstruct(java.lang.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.
- Type: java.lang.Object
Any object.
import com.hashicorp.cdktf.providers.google.bigtable_table.BigtableTable;
BigtableTable.isTerraformElement(java.lang.Object x)
- Type: java.lang.Object
import com.hashicorp.cdktf.providers.google.bigtable_table.BigtableTable;
BigtableTable.isTerraformResource(java.lang.Object x)
- Type: java.lang.Object
import com.hashicorp.cdktf.providers.google.bigtable_table.BigtableTable;
BigtableTable.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),BigtableTable.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)
Generates CDKTF code for importing a BigtableTable resource upon running "cdktf plan ".
- Type: software.constructs.Construct
The scope in which to define this construct.
- Type: java.lang.String
The construct id used in the generated config for the BigtableTable to import.
- Type: java.lang.String
The id of the existing BigtableTable that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#import import section} in the documentation of this resource for the id to use
- Type: com.hashicorp.cdktf.TerraformProvider
? Optional instance of the provider where the BigtableTable to import is found.
Name | Type | Description |
---|---|---|
node |
software.constructs.Node |
The tree node. |
cdktfStack |
com.hashicorp.cdktf.TerraformStack |
No description. |
fqn |
java.lang.String |
No description. |
friendlyUniqueId |
java.lang.String |
No description. |
terraformMetaArguments |
java.util.Map<java.lang.String, java.lang.Object> |
No description. |
terraformResourceType |
java.lang.String |
No description. |
terraformGeneratorMetadata |
com.hashicorp.cdktf.TerraformProviderGeneratorMetadata |
No description. |
connection |
com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection |
No description. |
count |
java.lang.Number OR com.hashicorp.cdktf.TerraformCount |
No description. |
dependsOn |
java.util.List<java.lang.String> |
No description. |
forEach |
com.hashicorp.cdktf.ITerraformIterator |
No description. |
lifecycle |
com.hashicorp.cdktf.TerraformResourceLifecycle |
No description. |
provider |
com.hashicorp.cdktf.TerraformProvider |
No description. |
provisioners |
java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> |
No description. |
automatedBackupPolicy |
BigtableTableAutomatedBackupPolicyOutputReference |
No description. |
columnFamily |
BigtableTableColumnFamilyList |
No description. |
timeouts |
BigtableTableTimeoutsOutputReference |
No description. |
automatedBackupPolicyInput |
BigtableTableAutomatedBackupPolicy |
No description. |
changeStreamRetentionInput |
java.lang.String |
No description. |
columnFamilyInput |
com.hashicorp.cdktf.IResolvable OR java.util.List<BigtableTableColumnFamily> |
No description. |
deletionProtectionInput |
java.lang.String |
No description. |
idInput |
java.lang.String |
No description. |
instanceNameInput |
java.lang.String |
No description. |
nameInput |
java.lang.String |
No description. |
projectInput |
java.lang.String |
No description. |
splitKeysInput |
java.util.List<java.lang.String> |
No description. |
timeoutsInput |
com.hashicorp.cdktf.IResolvable OR BigtableTableTimeouts |
No description. |
changeStreamRetention |
java.lang.String |
No description. |
deletionProtection |
java.lang.String |
No description. |
id |
java.lang.String |
No description. |
instanceName |
java.lang.String |
No description. |
name |
java.lang.String |
No description. |
project |
java.lang.String |
No description. |
splitKeys |
java.util.List<java.lang.String> |
No description. |
public Node getNode();
- Type: software.constructs.Node
The tree node.
public TerraformStack getCdktfStack();
- Type: com.hashicorp.cdktf.TerraformStack
public java.lang.String getFqn();
- Type: java.lang.String
public java.lang.String getFriendlyUniqueId();
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
- Type: java.util.Map<java.lang.String, java.lang.Object>
public java.lang.String getTerraformResourceType();
- Type: java.lang.String
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
- Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
public java.lang.Object getConnection();
- Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
public java.lang.Object getCount();
- Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
public java.util.List<java.lang.String> getDependsOn();
- Type: java.util.List<java.lang.String>
public ITerraformIterator getForEach();
- Type: com.hashicorp.cdktf.ITerraformIterator
public TerraformResourceLifecycle getLifecycle();
- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
public TerraformProvider getProvider();
- Type: com.hashicorp.cdktf.TerraformProvider
public java.lang.Object getProvisioners();
- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
public BigtableTableAutomatedBackupPolicyOutputReference getAutomatedBackupPolicy();
public BigtableTableColumnFamilyList getColumnFamily();
public BigtableTableTimeoutsOutputReference getTimeouts();
public BigtableTableAutomatedBackupPolicy getAutomatedBackupPolicyInput();
public java.lang.String getChangeStreamRetentionInput();
- Type: java.lang.String
public java.lang.Object getColumnFamilyInput();
- Type: com.hashicorp.cdktf.IResolvable OR java.util.List<BigtableTableColumnFamily>
public java.lang.String getDeletionProtectionInput();
- Type: java.lang.String
public java.lang.String getIdInput();
- Type: java.lang.String
public java.lang.String getInstanceNameInput();
- Type: java.lang.String
public java.lang.String getNameInput();
- Type: java.lang.String
public java.lang.String getProjectInput();
- Type: java.lang.String
public java.util.List<java.lang.String> getSplitKeysInput();
- Type: java.util.List<java.lang.String>
public java.lang.Object getTimeoutsInput();
- Type: com.hashicorp.cdktf.IResolvable OR BigtableTableTimeouts
public java.lang.String getChangeStreamRetention();
- Type: java.lang.String
public java.lang.String getDeletionProtection();
- Type: java.lang.String
public java.lang.String getId();
- Type: java.lang.String
public java.lang.String getInstanceName();
- Type: java.lang.String
public java.lang.String getName();
- Type: java.lang.String
public java.lang.String getProject();
- Type: java.lang.String
public java.util.List<java.lang.String> getSplitKeys();
- Type: java.util.List<java.lang.String>
Name | Type | Description |
---|---|---|
tfResourceType |
java.lang.String |
No description. |
public java.lang.String getTfResourceType();
- Type: java.lang.String
import com.hashicorp.cdktf.providers.google.bigtable_table.BigtableTableAutomatedBackupPolicy;
BigtableTableAutomatedBackupPolicy.builder()
// .frequency(java.lang.String)
// .retentionPeriod(java.lang.String)
.build();
Name | Type | Description |
---|---|---|
frequency |
java.lang.String |
How frequently automated backups should occur. |
retentionPeriod |
java.lang.String |
How long the automated backups should be retained. |
public java.lang.String getFrequency();
- Type: java.lang.String
How frequently automated backups should occur.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#frequency BigtableTable#frequency}
public java.lang.String getRetentionPeriod();
- Type: java.lang.String
How long the automated backups should be retained.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#retention_period BigtableTable#retention_period}
import com.hashicorp.cdktf.providers.google.bigtable_table.BigtableTableColumnFamily;
BigtableTableColumnFamily.builder()
.family(java.lang.String)
// .type(java.lang.String)
.build();
Name | Type | Description |
---|---|---|
family |
java.lang.String |
The name of the column family. |
type |
java.lang.String |
The type of the column family. |
public java.lang.String getFamily();
- Type: java.lang.String
The name of the column family.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#family BigtableTable#family}
public java.lang.String getType();
- Type: java.lang.String
The type of the column family.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#type BigtableTable#type}
import com.hashicorp.cdktf.providers.google.bigtable_table.BigtableTableConfig;
BigtableTableConfig.builder()
// .connection(SSHProvisionerConnection)
// .connection(WinrmProvisionerConnection)
// .count(java.lang.Number)
// .count(TerraformCount)
// .dependsOn(java.util.List<ITerraformDependable>)
// .forEach(ITerraformIterator)
// .lifecycle(TerraformResourceLifecycle)
// .provider(TerraformProvider)
// .provisioners(java.util.List<FileProvisioner)
// .provisioners(LocalExecProvisioner)
// .provisioners(RemoteExecProvisioner>)
.instanceName(java.lang.String)
.name(java.lang.String)
// .automatedBackupPolicy(BigtableTableAutomatedBackupPolicy)
// .changeStreamRetention(java.lang.String)
// .columnFamily(IResolvable)
// .columnFamily(java.util.List<BigtableTableColumnFamily>)
// .deletionProtection(java.lang.String)
// .id(java.lang.String)
// .project(java.lang.String)
// .splitKeys(java.util.List<java.lang.String>)
// .timeouts(BigtableTableTimeouts)
.build();
Name | Type | Description |
---|---|---|
connection |
com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection |
No description. |
count |
java.lang.Number OR com.hashicorp.cdktf.TerraformCount |
No description. |
dependsOn |
java.util.List<com.hashicorp.cdktf.ITerraformDependable> |
No description. |
forEach |
com.hashicorp.cdktf.ITerraformIterator |
No description. |
lifecycle |
com.hashicorp.cdktf.TerraformResourceLifecycle |
No description. |
provider |
com.hashicorp.cdktf.TerraformProvider |
No description. |
provisioners |
java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> |
No description. |
instanceName |
java.lang.String |
The name of the Bigtable instance. |
name |
java.lang.String |
The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers. |
automatedBackupPolicy |
BigtableTableAutomatedBackupPolicy |
automated_backup_policy block. |
changeStreamRetention |
java.lang.String |
Duration to retain change stream data for the table. |
columnFamily |
com.hashicorp.cdktf.IResolvable OR java.util.List<BigtableTableColumnFamily> |
column_family block. |
deletionProtection |
java.lang.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 |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#id BigtableTable#id}. |
project |
java.lang.String |
The ID of the project in which the resource belongs. |
splitKeys |
java.util.List<java.lang.String> |
A list of predefined keys to split the table on. |
timeouts |
BigtableTableTimeouts |
timeouts block. |
public java.lang.Object getConnection();
- Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
public java.lang.Object getCount();
- Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
public java.util.List<ITerraformDependable> getDependsOn();
- Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
public ITerraformIterator getForEach();
- Type: com.hashicorp.cdktf.ITerraformIterator
public TerraformResourceLifecycle getLifecycle();
- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
public TerraformProvider getProvider();
- Type: com.hashicorp.cdktf.TerraformProvider
public java.lang.Object getProvisioners();
- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
public java.lang.String getInstanceName();
- Type: java.lang.String
The name of the Bigtable instance.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#instance_name BigtableTable#instance_name}
public java.lang.String getName();
- Type: java.lang.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/6.17.0/docs/resources/bigtable_table#name BigtableTable#name}
public BigtableTableAutomatedBackupPolicy getAutomatedBackupPolicy();
automated_backup_policy block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#automated_backup_policy BigtableTable#automated_backup_policy}
public java.lang.String getChangeStreamRetention();
- Type: java.lang.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/6.17.0/docs/resources/bigtable_table#change_stream_retention BigtableTable#change_stream_retention}
public java.lang.Object getColumnFamily();
- Type: com.hashicorp.cdktf.IResolvable OR java.util.List<BigtableTableColumnFamily>
column_family block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#column_family BigtableTable#column_family}
public java.lang.String getDeletionProtection();
- Type: java.lang.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/6.17.0/docs/resources/bigtable_table#deletion_protection BigtableTable#deletion_protection}
public java.lang.String getId();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#id BigtableTable#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.
public java.lang.String getProject();
- Type: java.lang.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.17.0/docs/resources/bigtable_table#project BigtableTable#project}
public java.util.List<java.lang.String> getSplitKeys();
- Type: java.util.List<java.lang.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/6.17.0/docs/resources/bigtable_table#split_keys BigtableTable#split_keys}
public BigtableTableTimeouts getTimeouts();
- Type: BigtableTableTimeouts
timeouts block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#timeouts BigtableTable#timeouts}
import com.hashicorp.cdktf.providers.google.bigtable_table.BigtableTableTimeouts;
BigtableTableTimeouts.builder()
// .create(java.lang.String)
// .update(java.lang.String)
.build();
Name | Type | Description |
---|---|---|
create |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#create BigtableTable#create}. |
update |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#update BigtableTable#update}. |
public java.lang.String getCreate();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#create BigtableTable#create}.
public java.lang.String getUpdate();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#update BigtableTable#update}.
import com.hashicorp.cdktf.providers.google.bigtable_table.BigtableTableAutomatedBackupPolicyOutputReference;
new BigtableTableAutomatedBackupPolicyOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name | Type | Description |
---|---|---|
terraformResource |
com.hashicorp.cdktf.IInterpolatingParent |
The parent resource. |
terraformAttribute |
java.lang.String |
The attribute on the parent resource this class is referencing. |
- Type: com.hashicorp.cdktf.IInterpolatingParent
The parent resource.
- Type: java.lang.String
The attribute on the parent resource this class is referencing.
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. |
public java.lang.String computeFqn()
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable interpolationForAttribute(java.lang.String property)
- Type: java.lang.String
public java.lang.Object resolve(IResolveContext _context)
Produce the Token's value at resolution time.
- Type: com.hashicorp.cdktf.IResolveContext
public java.lang.String toString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
public void resetFrequency()
public void resetRetentionPeriod()
Name | Type | Description |
---|---|---|
creationStack |
java.util.List<java.lang.String> |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
java.lang.String |
No description. |
frequencyInput |
java.lang.String |
No description. |
retentionPeriodInput |
java.lang.String |
No description. |
frequency |
java.lang.String |
No description. |
retentionPeriod |
java.lang.String |
No description. |
internalValue |
BigtableTableAutomatedBackupPolicy |
No description. |
public java.util.List<java.lang.String> getCreationStack();
- Type: java.util.List<java.lang.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.
public java.lang.String getFqn();
- Type: java.lang.String
public java.lang.String getFrequencyInput();
- Type: java.lang.String
public java.lang.String getRetentionPeriodInput();
- Type: java.lang.String
public java.lang.String getFrequency();
- Type: java.lang.String
public java.lang.String getRetentionPeriod();
- Type: java.lang.String
public BigtableTableAutomatedBackupPolicy getInternalValue();
import com.hashicorp.cdktf.providers.google.bigtable_table.BigtableTableColumnFamilyList;
new BigtableTableColumnFamilyList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet);
Name | Type | Description |
---|---|---|
terraformResource |
com.hashicorp.cdktf.IInterpolatingParent |
The parent resource. |
terraformAttribute |
java.lang.String |
The attribute on the parent resource this class is referencing. |
wrapsSet |
java.lang.Boolean |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: com.hashicorp.cdktf.IInterpolatingParent
The parent resource.
- Type: java.lang.String
The attribute on the parent resource this class is referencing.
- Type: java.lang.Boolean
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
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. |
public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName)
Creating an iterator for this complex list.
The list will be converted into a map with the mapKeyAttributeName as the key.
- Type: java.lang.String
public java.lang.String computeFqn()
public java.lang.Object resolve(IResolveContext _context)
Produce the Token's value at resolution time.
- Type: com.hashicorp.cdktf.IResolveContext
public java.lang.String toString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
public BigtableTableColumnFamilyOutputReference get(java.lang.Number index)
- Type: java.lang.Number
the index of the item to return.
Name | Type | Description |
---|---|---|
creationStack |
java.util.List<java.lang.String> |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
java.lang.String |
No description. |
internalValue |
com.hashicorp.cdktf.IResolvable OR java.util.List<BigtableTableColumnFamily> |
No description. |
public java.util.List<java.lang.String> getCreationStack();
- Type: java.util.List<java.lang.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.
public java.lang.String getFqn();
- Type: java.lang.String
public java.lang.Object getInternalValue();
- Type: com.hashicorp.cdktf.IResolvable OR java.util.List<BigtableTableColumnFamily>
import com.hashicorp.cdktf.providers.google.bigtable_table.BigtableTableColumnFamilyOutputReference;
new BigtableTableColumnFamilyOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet);
Name | Type | Description |
---|---|---|
terraformResource |
com.hashicorp.cdktf.IInterpolatingParent |
The parent resource. |
terraformAttribute |
java.lang.String |
The attribute on the parent resource this class is referencing. |
complexObjectIndex |
java.lang.Number |
the index of this item in the list. |
complexObjectIsFromSet |
java.lang.Boolean |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: com.hashicorp.cdktf.IInterpolatingParent
The parent resource.
- Type: java.lang.String
The attribute on the parent resource this class is referencing.
- Type: java.lang.Number
the index of this item in the list.
- Type: java.lang.Boolean
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
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. |
public java.lang.String computeFqn()
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable interpolationForAttribute(java.lang.String property)
- Type: java.lang.String
public java.lang.Object resolve(IResolveContext _context)
Produce the Token's value at resolution time.
- Type: com.hashicorp.cdktf.IResolveContext
public java.lang.String toString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
public void resetType()
Name | Type | Description |
---|---|---|
creationStack |
java.util.List<java.lang.String> |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
java.lang.String |
No description. |
familyInput |
java.lang.String |
No description. |
typeInput |
java.lang.String |
No description. |
family |
java.lang.String |
No description. |
type |
java.lang.String |
No description. |
internalValue |
com.hashicorp.cdktf.IResolvable OR BigtableTableColumnFamily |
No description. |
public java.util.List<java.lang.String> getCreationStack();
- Type: java.util.List<java.lang.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.
public java.lang.String getFqn();
- Type: java.lang.String
public java.lang.String getFamilyInput();
- Type: java.lang.String
public java.lang.String getTypeInput();
- Type: java.lang.String
public java.lang.String getFamily();
- Type: java.lang.String
public java.lang.String getType();
- Type: java.lang.String
public java.lang.Object getInternalValue();
- Type: com.hashicorp.cdktf.IResolvable OR BigtableTableColumnFamily
import com.hashicorp.cdktf.providers.google.bigtable_table.BigtableTableTimeoutsOutputReference;
new BigtableTableTimeoutsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name | Type | Description |
---|---|---|
terraformResource |
com.hashicorp.cdktf.IInterpolatingParent |
The parent resource. |
terraformAttribute |
java.lang.String |
The attribute on the parent resource this class is referencing. |
- Type: com.hashicorp.cdktf.IInterpolatingParent
The parent resource.
- Type: java.lang.String
The attribute on the parent resource this class is referencing.
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. |
public java.lang.String computeFqn()
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable interpolationForAttribute(java.lang.String property)
- Type: java.lang.String
public java.lang.Object resolve(IResolveContext _context)
Produce the Token's value at resolution time.
- Type: com.hashicorp.cdktf.IResolveContext
public java.lang.String toString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
public void resetCreate()
public void resetUpdate()
Name | Type | Description |
---|---|---|
creationStack |
java.util.List<java.lang.String> |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
java.lang.String |
No description. |
createInput |
java.lang.String |
No description. |
updateInput |
java.lang.String |
No description. |
create |
java.lang.String |
No description. |
update |
java.lang.String |
No description. |
internalValue |
com.hashicorp.cdktf.IResolvable OR BigtableTableTimeouts |
No description. |
public java.util.List<java.lang.String> getCreationStack();
- Type: java.util.List<java.lang.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.
public java.lang.String getFqn();
- Type: java.lang.String
public java.lang.String getCreateInput();
- Type: java.lang.String
public java.lang.String getUpdateInput();
- Type: java.lang.String
public java.lang.String getCreate();
- Type: java.lang.String
public java.lang.String getUpdate();
- Type: java.lang.String
public java.lang.Object getInternalValue();
- Type: com.hashicorp.cdktf.IResolvable OR BigtableTableTimeouts