Package com.hashicorp.cdktf.providers.google.spanner_instance

Interface SpannerInstanceConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    SpannerInstanceConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:22.763Z")
@Stability(Stable)
public interface SpannerInstanceConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getConfig

        @Stability(Stable)
@NotNull
String getConfig()
        The name of the instance's configuration (similar but not quite the same as a region) which defines the geographic placement and replication of your databases in this instance.

        It determines where your data is stored. Values are typically of the form 'regional-europe-west1' , 'us-central' etc. In order to obtain a valid list please consult the [Configuration section of the docs](https://cloud.google.com/spanner/docs/instances). Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/spanner_instance#config SpannerInstance#config}

      • getDisplayName

        @Stability(Stable)
@NotNull
String getDisplayName()
        The descriptive name for this instance as it appears in UIs.

        Must be unique per project and between 4 and 30 characters in length. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/spanner_instance#display_name SpannerInstance#display_name}

      • getAutoscalingConfig

        @Stability(Stable)
@Nullable
default SpannerInstanceAutoscalingConfig getAutoscalingConfig()
        autoscaling_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/spanner_instance#autoscaling_config SpannerInstance#autoscaling_config}

      • getForceDestroy

        @Stability(Stable)
@Nullable
default Object getForceDestroy()
        When deleting a spanner instance, this boolean option will delete all backups of this instance.

        This must be set to true if you created a backup manually in the console. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/spanner_instance#force_destroy SpannerInstance#force_destroy}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/spanner_instance#id SpannerInstance#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.

      • getLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getLabels()
        An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

        **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/spanner_instance#labels SpannerInstance#labels}

      • getName

        @Stability(Stable)
@Nullable
default String getName()
        A unique identifier for the instance, which cannot be changed after the instance is created.

        The name must be between 6 and 30 characters in length. If not provided, a random string starting with 'tf-' will be selected. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/spanner_instance#name SpannerInstance#name}

      • getNumNodes

        @Stability(Stable)
@Nullable
default Number getNumNodes()
        The number of nodes allocated to this instance. Exactly one of either node_count or processing_units must be present in terraform.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/spanner_instance#num_nodes SpannerInstance#num_nodes}

      • getProcessingUnits

        @Stability(Stable)
@Nullable
default Number getProcessingUnits()
        The number of processing units allocated to this instance. Exactly one of processing_units or node_count must be present in terraform.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/spanner_instance#processing_units SpannerInstance#processing_units}

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/spanner_instance#project SpannerInstance#project}.

      • getTimeouts

        @Stability(Stable)
@Nullable
default SpannerInstanceTimeouts getTimeouts()
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/spanner_instance#timeouts SpannerInstance#timeouts}