Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. spanner
  5. InstancePartition
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.spanner.InstancePartition

Explore with Pulumi AI

gcp logo
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

    A Cloud Spanner instance partition is a unit of Cloud Spanner database capacity that can be used to partition data and processing capacity within an instance.

    To get more information about InstancePartition, see:

    Example Usage

    Spanner Instance Partition Basic

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const main = new gcp.spanner.Instance("main", {
    name: "test-instance",
    config: "nam6",
    displayName: "main-instance",
    numNodes: 1,
    edition: "ENTERPRISE_PLUS",
});
const partition = new gcp.spanner.InstancePartition("partition", {
    name: "test-partition",
    instance: main.name,
    config: "nam8",
    displayName: "test-spanner-partition",
    nodeCount: 1,
});

    import pulumi
import pulumi_gcp as gcp

main = gcp.spanner.Instance("main",
    name="test-instance",
    config="nam6",
    display_name="main-instance",
    num_nodes=1,
    edition="ENTERPRISE_PLUS")
partition = gcp.spanner.InstancePartition("partition",
    name="test-partition",
    instance=main.name,
    config="nam8",
    display_name="test-spanner-partition",
    node_count=1)

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/spanner"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		main, err := spanner.NewInstance(ctx, "main", &spanner.InstanceArgs{
			Name:        pulumi.String("test-instance"),
			Config:      pulumi.String("nam6"),
			DisplayName: pulumi.String("main-instance"),
			NumNodes:    pulumi.Int(1),
			Edition:     pulumi.String("ENTERPRISE_PLUS"),
		})
		if err != nil {
			return err
		}
		_, err = spanner.NewInstancePartition(ctx, "partition", &spanner.InstancePartitionArgs{
			Name:        pulumi.String("test-partition"),
			Instance:    main.Name,
			Config:      pulumi.String("nam8"),
			DisplayName: pulumi.String("test-spanner-partition"),
			NodeCount:   pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var main = new Gcp.Spanner.Instance("main", new()
    {
        Name = "test-instance",
        Config = "nam6",
        DisplayName = "main-instance",
        NumNodes = 1,
        Edition = "ENTERPRISE_PLUS",
    });

    var partition = new Gcp.Spanner.InstancePartition("partition", new()
    {
        Name = "test-partition",
        Instance = main.Name,
        Config = "nam8",
        DisplayName = "test-spanner-partition",
        NodeCount = 1,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.spanner.Instance;
import com.pulumi.gcp.spanner.InstanceArgs;
import com.pulumi.gcp.spanner.InstancePartition;
import com.pulumi.gcp.spanner.InstancePartitionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var main = new Instance("main", InstanceArgs.builder()
            .name("test-instance")
            .config("nam6")
            .displayName("main-instance")
            .numNodes(1)
            .edition("ENTERPRISE_PLUS")
            .build());

        var partition = new InstancePartition("partition", InstancePartitionArgs.builder()
            .name("test-partition")
            .instance(main.name())
            .config("nam8")
            .displayName("test-spanner-partition")
            .nodeCount(1)
            .build());

    }
}

    resources:
  main:
    type: gcp:spanner:Instance
    properties:
      name: test-instance
      config: nam6
      displayName: main-instance
      numNodes: 1
      edition: ENTERPRISE_PLUS
  partition:
    type: gcp:spanner:InstancePartition
    properties:
      name: test-partition
      instance: ${main.name}
      config: nam8
      displayName: test-spanner-partition
      nodeCount: 1

    Create InstancePartition Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new InstancePartition(name: string, args: InstancePartitionArgs, opts?: CustomResourceOptions);
    @overload
def InstancePartition(resource_name: str,
                      args: InstancePartitionArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def InstancePartition(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      config: Optional[str] = None,
                      display_name: Optional[str] = None,
                      instance: Optional[str] = None,
                      name: Optional[str] = None,
                      node_count: Optional[int] = None,
                      processing_units: Optional[int] = None,
                      project: Optional[str] = None)
    func NewInstancePartition(ctx *Context, name string, args InstancePartitionArgs, opts ...ResourceOption) (*InstancePartition, error)
    public InstancePartition(string name, InstancePartitionArgs args, CustomResourceOptions? opts = null)
    public InstancePartition(String name, InstancePartitionArgs args)
public InstancePartition(String name, InstancePartitionArgs args, CustomResourceOptions options)

    type: gcp:spanner:InstancePartition
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args InstancePartitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InstancePartitionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InstancePartitionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstancePartitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstancePartitionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var instancePartitionResource = new Gcp.Spanner.InstancePartition("instancePartitionResource", new()
{
    Config = "string",
    DisplayName = "string",
    Instance = "string",
    Name = "string",
    NodeCount = 0,
    ProcessingUnits = 0,
    Project = "string",
});

    example, err := spanner.NewInstancePartition(ctx, "instancePartitionResource", &spanner.InstancePartitionArgs{
	Config:          pulumi.String("string"),
	DisplayName:     pulumi.String("string"),
	Instance:        pulumi.String("string"),
	Name:            pulumi.String("string"),
	NodeCount:       pulumi.Int(0),
	ProcessingUnits: pulumi.Int(0),
	Project:         pulumi.String("string"),
})

    var instancePartitionResource = new InstancePartition("instancePartitionResource", InstancePartitionArgs.builder()
    .config("string")
    .displayName("string")
    .instance("string")
    .name("string")
    .nodeCount(0)
    .processingUnits(0)
    .project("string")
    .build());

    instance_partition_resource = gcp.spanner.InstancePartition("instancePartitionResource",
    config="string",
    display_name="string",
    instance="string",
    name="string",
    node_count=0,
    processing_units=0,
    project="string")

    const instancePartitionResource = new gcp.spanner.InstancePartition("instancePartitionResource", {
    config: "string",
    displayName: "string",
    instance: "string",
    name: "string",
    nodeCount: 0,
    processingUnits: 0,
    project: "string",
});

    type: gcp:spanner:InstancePartition
properties:
    config: string
    displayName: string
    instance: string
    name: string
    nodeCount: 0
    processingUnits: 0
    project: string

    InstancePartition Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The InstancePartition resource accepts the following input properties:

    Config string
    The name of the instance partition's configuration (similar to a region) which defines the geographic placement and replication of data in this instance partition.
    DisplayName string
    The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
    Instance string
    The instance to create the instance partition in.

    Name string
    A unique identifier for the instance partition, which cannot be changed after the instance partition is created. The name must be between 2 and 64 characters and match the regular expression [a-z][a-z0-9\-]{0,61}[a-z0-9].
    NodeCount int
    The number of nodes allocated to this instance partition. One node equals 1000 processing units. Exactly one of either node_count or processing_units must be present.
    ProcessingUnits int
    The number of processing units allocated to this instance partition. Exactly one of either node_count or processing_units must be present.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Config string
    The name of the instance partition's configuration (similar to a region) which defines the geographic placement and replication of data in this instance partition.
    DisplayName string
    The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
    Instance string
    The instance to create the instance partition in.

    Name string
    A unique identifier for the instance partition, which cannot be changed after the instance partition is created. The name must be between 2 and 64 characters and match the regular expression [a-z][a-z0-9\-]{0,61}[a-z0-9].
    NodeCount int
    The number of nodes allocated to this instance partition. One node equals 1000 processing units. Exactly one of either node_count or processing_units must be present.
    ProcessingUnits int
    The number of processing units allocated to this instance partition. Exactly one of either node_count or processing_units must be present.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    config String
    The name of the instance partition's configuration (similar to a region) which defines the geographic placement and replication of data in this instance partition.
    displayName String
    The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
    instance String
    The instance to create the instance partition in.

    name String
    A unique identifier for the instance partition, which cannot be changed after the instance partition is created. The name must be between 2 and 64 characters and match the regular expression [a-z][a-z0-9\-]{0,61}[a-z0-9].
    nodeCount Integer
    The number of nodes allocated to this instance partition. One node equals 1000 processing units. Exactly one of either node_count or processing_units must be present.
    processingUnits Integer
    The number of processing units allocated to this instance partition. Exactly one of either node_count or processing_units must be present.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    config string
    The name of the instance partition's configuration (similar to a region) which defines the geographic placement and replication of data in this instance partition.
    displayName string
    The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
    instance string
    The instance to create the instance partition in.

    name string
    A unique identifier for the instance partition, which cannot be changed after the instance partition is created. The name must be between 2 and 64 characters and match the regular expression [a-z][a-z0-9\-]{0,61}[a-z0-9].
    nodeCount number
    The number of nodes allocated to this instance partition. One node equals 1000 processing units. Exactly one of either node_count or processing_units must be present.
    processingUnits number
    The number of processing units allocated to this instance partition. Exactly one of either node_count or processing_units must be present.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    config str
    The name of the instance partition's configuration (similar to a region) which defines the geographic placement and replication of data in this instance partition.
    display_name str
    The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
    instance str
    The instance to create the instance partition in.

    name str
    A unique identifier for the instance partition, which cannot be changed after the instance partition is created. The name must be between 2 and 64 characters and match the regular expression [a-z][a-z0-9\-]{0,61}[a-z0-9].
    node_count int
    The number of nodes allocated to this instance partition. One node equals 1000 processing units. Exactly one of either node_count or processing_units must be present.
    processing_units int
    The number of processing units allocated to this instance partition. Exactly one of either node_count or processing_units must be present.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    config String
    The name of the instance partition's configuration (similar to a region) which defines the geographic placement and replication of data in this instance partition.
    displayName String
    The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
    instance String
    The instance to create the instance partition in.

    name String
    A unique identifier for the instance partition, which cannot be changed after the instance partition is created. The name must be between 2 and 64 characters and match the regular expression [a-z][a-z0-9\-]{0,61}[a-z0-9].
    nodeCount Number
    The number of nodes allocated to this instance partition. One node equals 1000 processing units. Exactly one of either node_count or processing_units must be present.
    processingUnits Number
    The number of processing units allocated to this instance partition. Exactly one of either node_count or processing_units must be present.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the InstancePartition resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current instance partition state. Possible values are: CREATING: The instance partition is being created. Resources are being allocated for the instance partition. READY: The instance partition has been allocated resources and is ready for use.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current instance partition state. Possible values are: CREATING: The instance partition is being created. Resources are being allocated for the instance partition. READY: The instance partition has been allocated resources and is ready for use.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current instance partition state. Possible values are: CREATING: The instance partition is being created. Resources are being allocated for the instance partition. READY: The instance partition has been allocated resources and is ready for use.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The current instance partition state. Possible values are: CREATING: The instance partition is being created. Resources are being allocated for the instance partition. READY: The instance partition has been allocated resources and is ready for use.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The current instance partition state. Possible values are: CREATING: The instance partition is being created. Resources are being allocated for the instance partition. READY: The instance partition has been allocated resources and is ready for use.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current instance partition state. Possible values are: CREATING: The instance partition is being created. Resources are being allocated for the instance partition. READY: The instance partition has been allocated resources and is ready for use.

    Look up Existing InstancePartition Resource

    Get an existing InstancePartition resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: InstancePartitionState, opts?: CustomResourceOptions): InstancePartition
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[str] = None,
        display_name: Optional[str] = None,
        instance: Optional[str] = None,
        name: Optional[str] = None,
        node_count: Optional[int] = None,
        processing_units: Optional[int] = None,
        project: Optional[str] = None,
        state: Optional[str] = None) -> InstancePartition
    func GetInstancePartition(ctx *Context, name string, id IDInput, state *InstancePartitionState, opts ...ResourceOption) (*InstancePartition, error)
    public static InstancePartition Get(string name, Input<string> id, InstancePartitionState? state, CustomResourceOptions? opts = null)
    public static InstancePartition get(String name, Output<String> id, InstancePartitionState state, CustomResourceOptions options)
    resources:  _:    type: gcp:spanner:InstancePartition    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Config string
    The name of the instance partition's configuration (similar to a region) which defines the geographic placement and replication of data in this instance partition.
    DisplayName string
    The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
    Instance string
    The instance to create the instance partition in.

    Name string
    A unique identifier for the instance partition, which cannot be changed after the instance partition is created. The name must be between 2 and 64 characters and match the regular expression [a-z][a-z0-9\-]{0,61}[a-z0-9].
    NodeCount int
    The number of nodes allocated to this instance partition. One node equals 1000 processing units. Exactly one of either node_count or processing_units must be present.
    ProcessingUnits int
    The number of processing units allocated to this instance partition. Exactly one of either node_count or processing_units must be present.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    State string
    The current instance partition state. Possible values are: CREATING: The instance partition is being created. Resources are being allocated for the instance partition. READY: The instance partition has been allocated resources and is ready for use.
    Config string
    The name of the instance partition's configuration (similar to a region) which defines the geographic placement and replication of data in this instance partition.
    DisplayName string
    The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
    Instance string
    The instance to create the instance partition in.

    Name string
    A unique identifier for the instance partition, which cannot be changed after the instance partition is created. The name must be between 2 and 64 characters and match the regular expression [a-z][a-z0-9\-]{0,61}[a-z0-9].
    NodeCount int
    The number of nodes allocated to this instance partition. One node equals 1000 processing units. Exactly one of either node_count or processing_units must be present.
    ProcessingUnits int
    The number of processing units allocated to this instance partition. Exactly one of either node_count or processing_units must be present.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    State string
    The current instance partition state. Possible values are: CREATING: The instance partition is being created. Resources are being allocated for the instance partition. READY: The instance partition has been allocated resources and is ready for use.
    config String
    The name of the instance partition's configuration (similar to a region) which defines the geographic placement and replication of data in this instance partition.
    displayName String
    The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
    instance String
    The instance to create the instance partition in.

    name String
    A unique identifier for the instance partition, which cannot be changed after the instance partition is created. The name must be between 2 and 64 characters and match the regular expression [a-z][a-z0-9\-]{0,61}[a-z0-9].
    nodeCount Integer
    The number of nodes allocated to this instance partition. One node equals 1000 processing units. Exactly one of either node_count or processing_units must be present.
    processingUnits Integer
    The number of processing units allocated to this instance partition. Exactly one of either node_count or processing_units must be present.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    state String
    The current instance partition state. Possible values are: CREATING: The instance partition is being created. Resources are being allocated for the instance partition. READY: The instance partition has been allocated resources and is ready for use.
    config string
    The name of the instance partition's configuration (similar to a region) which defines the geographic placement and replication of data in this instance partition.
    displayName string
    The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
    instance string
    The instance to create the instance partition in.

    name string
    A unique identifier for the instance partition, which cannot be changed after the instance partition is created. The name must be between 2 and 64 characters and match the regular expression [a-z][a-z0-9\-]{0,61}[a-z0-9].
    nodeCount number
    The number of nodes allocated to this instance partition. One node equals 1000 processing units. Exactly one of either node_count or processing_units must be present.
    processingUnits number
    The number of processing units allocated to this instance partition. Exactly one of either node_count or processing_units must be present.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    state string
    The current instance partition state. Possible values are: CREATING: The instance partition is being created. Resources are being allocated for the instance partition. READY: The instance partition has been allocated resources and is ready for use.
    config str
    The name of the instance partition's configuration (similar to a region) which defines the geographic placement and replication of data in this instance partition.
    display_name str
    The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
    instance str
    The instance to create the instance partition in.

    name str
    A unique identifier for the instance partition, which cannot be changed after the instance partition is created. The name must be between 2 and 64 characters and match the regular expression [a-z][a-z0-9\-]{0,61}[a-z0-9].
    node_count int
    The number of nodes allocated to this instance partition. One node equals 1000 processing units. Exactly one of either node_count or processing_units must be present.
    processing_units int
    The number of processing units allocated to this instance partition. Exactly one of either node_count or processing_units must be present.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    state str
    The current instance partition state. Possible values are: CREATING: The instance partition is being created. Resources are being allocated for the instance partition. READY: The instance partition has been allocated resources and is ready for use.
    config String
    The name of the instance partition's configuration (similar to a region) which defines the geographic placement and replication of data in this instance partition.
    displayName String
    The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
    instance String
    The instance to create the instance partition in.

    name String
    A unique identifier for the instance partition, which cannot be changed after the instance partition is created. The name must be between 2 and 64 characters and match the regular expression [a-z][a-z0-9\-]{0,61}[a-z0-9].
    nodeCount Number
    The number of nodes allocated to this instance partition. One node equals 1000 processing units. Exactly one of either node_count or processing_units must be present.
    processingUnits Number
    The number of processing units allocated to this instance partition. Exactly one of either node_count or processing_units must be present.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    state String
    The current instance partition state. Possible values are: CREATING: The instance partition is being created. Resources are being allocated for the instance partition. READY: The instance partition has been allocated resources and is ready for use.

    Import

    InstancePartition can be imported using any of these accepted formats:

    • projects/{{project}}/instances/{{instance}}/instancePartitions/{{name}}

    • {{project}}/{{instance}}/{{name}}

    • {{instance}}/{{name}}

    When using the pulumi import command, InstancePartition can be imported using one of the formats above. For example:

    $ pulumi import gcp:spanner/instancePartition:InstancePartition default projects/{{project}}/instances/{{instance}}/instancePartitions/{{name}}

    $ pulumi import gcp:spanner/instancePartition:InstancePartition default {{project}}/{{instance}}/{{name}}

    $ pulumi import gcp:spanner/instancePartition:InstancePartition default {{instance}}/{{name}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
    pulumi/pulumi-gcp