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

Class SpannerInstanceConfig.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • config

        @Stability(Stable)
public SpannerInstanceConfig.Builder config​(String config)
        Sets the value of SpannerInstanceConfig.getConfig()
        Parameters:
        config - 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. This parameter is required. 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}
        Returns:
        this

      • displayName

        @Stability(Stable)
public SpannerInstanceConfig.Builder displayName​(String displayName)
        Sets the value of SpannerInstanceConfig.getDisplayName()
        Parameters:
        displayName - The descriptive name for this instance as it appears in UIs. This parameter is required. 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}
        Returns:
        this

      • forceDestroy

        @Stability(Stable)
public SpannerInstanceConfig.Builder forceDestroy​(Boolean forceDestroy)
        Sets the value of SpannerInstanceConfig.getForceDestroy()
        Parameters:
        forceDestroy - 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}
        Returns:
        this

      • forceDestroy

        @Stability(Stable)
public SpannerInstanceConfig.Builder forceDestroy​(com.hashicorp.cdktf.IResolvable forceDestroy)
        Sets the value of SpannerInstanceConfig.getForceDestroy()
        Parameters:
        forceDestroy - 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}
        Returns:
        this

      • id

        @Stability(Stable)
public SpannerInstanceConfig.Builder id​(String id)
        Sets the value of SpannerInstanceConfig.getId()
        Parameters:
        id - 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.
        Returns:
        this

      • labels

        @Stability(Stable)
public SpannerInstanceConfig.Builder labels​(Map<String,​String> labels)
        Sets the value of SpannerInstanceConfig.getLabels()
        Parameters:
        labels - 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}
        Returns:
        this

      • name

        @Stability(Stable)
public SpannerInstanceConfig.Builder name​(String name)
        Sets the value of SpannerInstanceConfig.getName()
        Parameters:
        name - 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}
        Returns:
        this

      • numNodes

        @Stability(Stable)
public SpannerInstanceConfig.Builder numNodes​(Number numNodes)
        Sets the value of SpannerInstanceConfig.getNumNodes()
        Parameters:
        numNodes - 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}
        Returns:
        this

      • processingUnits

        @Stability(Stable)
public SpannerInstanceConfig.Builder processingUnits​(Number processingUnits)
        Sets the value of SpannerInstanceConfig.getProcessingUnits()
        Parameters:
        processingUnits - 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}
        Returns:
        this

      • project

        @Stability(Stable)
public SpannerInstanceConfig.Builder project​(String project)
        Sets the value of SpannerInstanceConfig.getProject()
        Parameters:
        project - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/spanner_instance#project SpannerInstance#project}.
        Returns:
        this

      • connection

        @Stability(Experimental)
public SpannerInstanceConfig.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Sets the value of TerraformMetaArguments.getConnection()
        Parameters:
        connection - the value to be set.
        Returns:
        this

      • connection

        @Stability(Experimental)
public SpannerInstanceConfig.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Sets the value of TerraformMetaArguments.getConnection()
        Parameters:
        connection - the value to be set.
        Returns:
        this

      • count

        @Stability(Experimental)
public SpannerInstanceConfig.Builder count​(Number count)
        Sets the value of TerraformMetaArguments.getCount()
        Parameters:
        count - the value to be set.
        Returns:
        this

      • count

        @Stability(Experimental)
public SpannerInstanceConfig.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Sets the value of TerraformMetaArguments.getCount()
        Parameters:
        count - the value to be set.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public SpannerInstanceConfig.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Sets the value of TerraformMetaArguments.getDependsOn()
        Parameters:
        dependsOn - the value to be set.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public SpannerInstanceConfig.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Sets the value of TerraformMetaArguments.getForEach()
        Parameters:
        forEach - the value to be set.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public SpannerInstanceConfig.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Sets the value of TerraformMetaArguments.getLifecycle()
        Parameters:
        lifecycle - the value to be set.
        Returns:
        this

      • provider

        @Stability(Experimental)
public SpannerInstanceConfig.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Sets the value of TerraformMetaArguments.getProvider()
        Parameters:
        provider - the value to be set.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public SpannerInstanceConfig.Builder provisioners​(List<? extends Object> provisioners)
        Sets the value of TerraformMetaArguments.getProvisioners()
        Parameters:
        provisioners - the value to be set.
        Returns:
        this