GoogleSpannerInstanceConfig class final

Factory wrapper for google_spanner_instance_config.

A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.

Cloud Spanner user-managed instance configuration — replica topology metadata cloned from a Google-managed baseConfig. Creating the config does not create a GoogleSpannerInstance and does not reserve nodes or processing units.

name must start with custom-. The Terraform provider merges baseConfig replicas automatically — pass only the extra optional READ_ONLY replica (official recipe: nam11 + us-west1).

Enable spanner.googleapis.com via GoogleProjectService before apply. Set deletionPolicy to DELETE so destroy removes the unused config. Do not attach a GoogleSpannerInstance unless you intend to pay node / PU SKUs.

Example:

GoogleSpannerInstanceConfig(
  'custom_nam11',
  name: TfArg.literal('custom-td-nam11-ro'),
  displayName: TfArg.literal('TerraDart nam11 + us-west1 RO'),
  baseConfig: TfArg.literal('nam11'),
  replicas: [
    SpannerInstanceConfigReplicas(
      location: TfArg.literal('us-west1'),
      type: SpannerInstanceConfigReplicasType.readOnly,
      defaultLeaderLocation: TfArg.literal(false),
    ),
  ],
  deletionPolicy: TfArg.literal('DELETE'),
);
Inheritance

Constructors

GoogleSpannerInstanceConfig(String localName, {TfArg<String>? name, required TfArg<String> displayName, TfArg<String>? baseConfig, required List<SpannerInstanceConfigReplicas> replicas, TfArg<Map<String, String>>? labels, TfArg<String>? deletionPolicy, TfArg<String>? project, LifecycleOptions? lifecycle, List<TfAddressed>? dependsOn, StackProvider? provider, TfTimeouts? timeouts})

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
baseConfig → TfRef<String>
Reference to base_config attribute.
no setter
configType → TfRef<String>
Reference to config_type attribute.
no setter
defaultProvider → String
The provider name a block without provider uses: by default the prefix of terraformType (google for google_pubsub_topic).
no setterinherited
deletionPolicy → TfRef<String>
Reference to deletion_policy attribute.
no setter
dependsOn → List<TfAddressed>?
Optional depends_on = [...]: the resources, data sources and module calls this block waits for, e.g. [api, ...apiDeps]. Terraform takes whole blocks only, so an entry is never an attribute.
finalinherited
displayName → TfRef<String>
Reference to display_name attribute.
no setter
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
labels → TfRef<Map<String, String>>
Reference to labels attribute.
no setter
lifecycle → LifecycleOptions?
Optional lifecycle { ... } block.
finalinherited
localName → String
User-supplied local name within a Stack.
finalinherited
name → TfRef<String>
Reference to name attribute.
no setter
project → TfRef<String>
Reference to project attribute.
no setter
provider → StackProvider?
Optional Terraform provider meta-argument: the provider configuration this block uses, e.g. a GoogleProvider with an alias the Stack registered with addProvider.
finalinherited
ref → RefTo<GoogleSpannerInstanceConfig>
A reference to this resource, for arguments typed RefTo<GoogleSpannerInstanceConfig>.
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 setteroverride
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 setterinherited
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
Terraform address <terraformType>.<localName>, e.g. google_pubsub_topic.orders.
no setterinherited
timeouts → TfTimeouts?
Optional timeouts { ... } block: how long Terraform waits for each operation. Provider-neutral like lifecycle — synth copies the duration strings verbatim, and terraform validate decides whether this resource's schema declares the operations set here.
finalinherited

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