GoogleBigtableInstance class final

Factory wrapper for google_bigtable_instance.

Cloud Bigtable instance — the top-level container for clusters and tables.

Required identity:

localName: Terraform local name.
name: instance ID (6-33 chars, lowercase letters, numbers, hyphens).
cluster: at least one BigtableInstanceCluster (zone + node count).

Enable bigtableadmin.googleapis.com via Apis.enable before apply.

Example (single-zone development instance):

GoogleBigtableInstance(
  localName: 'events',
  name: TfArg.literal('events-dev'),
  instanceType: TfArg.literal(BigtableInstanceType.development),
  cluster: [
    BigtableInstanceCluster(
      clusterId: TfArg.literal('events-c1'),
      zone: TfArg.literal('us-central1-b'),
      numNodes: TfArg.literal(1),
    ),
  ],
);

Constructors

GoogleBigtableInstance({required String localName, required TfArg<String> name, List<BigtableInstanceCluster>? cluster, TfArg<String>? displayName, TfArg<BigtableInstanceType>? instanceType, TfArg<BigtableInstanceEdition>? edition, TfArg<Map<String, String>>? labels, TfArg<String>? deletionPolicy, TfArg<bool>? deletionProtection, TfArg<bool>? forceDestroy, TfArg<String>? project, LifecycleOptions? lifecycle, List<DependencyTarget>? dependsOn})

Properties

argMap → Map<String, TfArg?>: Argument-name → TfArg map. Keys are snake_case (Terraform JSON name). Synth emits these keys directly; the factory is responsible for the camelCase → snake_case translation at construction time.
finalinherited
dependsOn → List<DependencyTarget>?: Optional depends_on = [...]. Each entry is a DependencyTarget — either a wholesale resource (rendered as bare address) or an explicit TfRef (rendered via bareAddress).
finalinherited
effectiveLabels → TfRef<Map<String, String>>: Reference to effective_labels attribute.
no setter
hashCode → int: The hash code for this object.
no setterinherited
id → TfRef<String>: Reference to id attribute.
no setter
kind → ResourceKind: Always ResourceKind.resource. Overridden by Data.
no setterinherited
lifecycle → LifecycleOptions?: Optional lifecycle { ... } block.
finalinherited
localName → String: User-supplied local name within a Stack.
finalinherited
nameRef → TfRef<String>: no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
sensitiveFields → Set<String>: Field names that are @Sensitive per the IR-derived per-resource constant. Curated factories override with a baked-in static const Set<String> (file-private in v0.5+).
no setter
supportsDeletionProtection → bool: Capability flag: true when this resource's underlying Terraform schema has a deletion_protection boolean attribute that the synth-time devMode flow can flip to false. Defaults to false; the codegen emitter overrides this to true for wrappers whose schema includes the attribute.
no setter
terraformLabels → TfRef<Map<String, String>>: Reference to terraform_labels attribute.
no setter
terraformType → String: Terraform resource type, e.g. google_pubsub_topic.
finalinherited
tfAddress → String: no setterinherited

Methods

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

Operators

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

Constants

tfType → const String