TableArgs class

The set of arguments for Table. The set of arguments for Table.

Constructors

TableArgs({Input<TableAutomatedBackupPolicy?>? automatedBackupPolicy, Input<String?>? changeStreamRetention, Input<List<TableColumnFamily>?>? columnFamilies, Input<String?>? deletionPolicy, Input<String?>? deletionProtection, required Input<String> instanceName, Input<String?>? name, Input<String?>? project, Input<String?>? rowKeySchema, Input<List<String>?>? splitKeys})
Creates a new TableArgs. automatedBackupPolicy Defines an automated backup policy for a table, specified by retentionPeriod and frequency. To create a table with automated backup disabled, either omit the automatedBackupPolicy argument or set both retentionPeriod and frequency to "0". To disable automated backup on an existing table that has automated backup enabled, set both retentionPeriod and frequency to "0". When updating an existing table, change the retentionPeriod or frequency by setting the respective property to a non-zero value. The policy also accepts an optional locations list to specify backup storage locations; if locations is omitted, the policy defaults to all clusters in the instance. If the automatedBackupPolicy argument is not provided on update, the resource's automated backup policy will not be modified. changeStreamRetention Duration to retain change stream data for the table. Set to 0 to disable. Must be between 1 and 7 days. columnFamilies A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". deletionProtection 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, deletion protection will be set to UNPROTECTED. instanceName The name of the Bigtable instance. name The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers. project The ID of the project in which the resource belongs. If it rowKeySchema Defines the row key schema of a table. To create or update a table with a row key schema, specify this argument. splitKeys A list of predefined keys to split the table on.
const
TableArgs.fromMap(Map<String, dynamic> map)
factory

Properties

automatedBackupPolicy → Input<TableAutomatedBackupPolicy?>?
Defines an automated backup policy for a table, specified by retentionPeriod and frequency. To create a table with automated backup disabled, either omit the automatedBackupPolicy argument or set both retentionPeriod and frequency to "0". To disable automated backup on an existing table that has automated backup enabled, set both retentionPeriod and frequency to "0". When updating an existing table, change the retentionPeriod or frequency by setting the respective property to a non-zero value. The policy also accepts an optional locations list to specify backup storage locations; if locations is omitted, the policy defaults to all clusters in the instance. If the automatedBackupPolicy argument is not provided on update, the resource's automated backup policy will not be modified.
final
changeStreamRetention → Input<String?>?
Duration to retain change stream data for the table. Set to 0 to disable. Must be between 1 and 7 days.
final
columnFamilies → Input<List<TableColumnFamily>?>?
A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
deletionProtection → Input<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, deletion protection will be set to UNPROTECTED.
final
hashCode → int
The hash code for this object.
no setterinherited
instanceName → Input<String>
The name of the Bigtable instance.
final
name → Input<String?>?
The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
rowKeySchema → Input<String?>?
Defines the row key schema of a table. To create or update a table with a row key schema, specify this argument. Note that in-place update is not supported, and any in-place modification to the schema will lead to failure. To update a schema, please clear it (by omitting the field), and update the resource again with a new schema.\n
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
splitKeys → Input<List<String>?>?
A list of predefined keys to split the table on. > Warning: Modifying the splitKeys of an existing table will cause the provider to delete/recreate the entire gcp.bigtable.Table resource.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited