1. Docs
  2. Reference
  3. API
  4. GCP
  5. spanner
  6. Instance

Instance

An isolated set of Cloud Spanner resources on which databases can be hosted.

To get more information about Instance, see:

Create a Instance Resource

new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
def Instance(resource_name, opts=None, config=None, display_name=None, labels=None, name=None, num_nodes=None, project=None, __props__=None);
func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args InstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args InstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args InstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Instance Resource Properties

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

Inputs

The Instance resource accepts the following input properties:

Config string

The name of the instance’s configuration (similar but not quite the same as a region) which defines 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.

DisplayName string

The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

Labels Dictionary<string, string>

An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

Name string

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.

NumNodes int

The number of nodes allocated to this instance.

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’s configuration (similar but not quite the same as a region) which defines 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.

DisplayName string

The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

Labels map[string]string

An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

Name string

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.

NumNodes int

The number of nodes allocated to this instance.

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’s configuration (similar but not quite the same as a region) which defines 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.

displayName string

The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

labels {[key: string]: string}

An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

name string

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.

numNodes number

The number of nodes allocated to this instance.

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’s configuration (similar but not quite the same as a region) which defines 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.

display_name str

The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

labels Dict[str, str]

An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

name str

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.

num_nodes float

The number of nodes allocated to this instance.

project str

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 Instance resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
State string

Instance status: ‘CREATING’ or ‘READY’.

Id string
The provider-assigned unique ID for this managed resource.
State string

Instance status: ‘CREATING’ or ‘READY’.

id string
The provider-assigned unique ID for this managed resource.
state string

Instance status: ‘CREATING’ or ‘READY’.

id str
The provider-assigned unique ID for this managed resource.
state str

Instance status: ‘CREATING’ or ‘READY’.

Look up an Existing Instance Resource

Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance
static get(resource_name, id, opts=None, config=None, display_name=None, labels=None, name=None, num_nodes=None, project=None, state=None, __props__=None);
func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

Config string

The name of the instance’s configuration (similar but not quite the same as a region) which defines 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.

DisplayName string

The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

Labels Dictionary<string, string>

An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

Name string

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.

NumNodes int

The number of nodes allocated to this instance.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

State string

Instance status: ‘CREATING’ or ‘READY’.

Config string

The name of the instance’s configuration (similar but not quite the same as a region) which defines 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.

DisplayName string

The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

Labels map[string]string

An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

Name string

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.

NumNodes int

The number of nodes allocated to this instance.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

State string

Instance status: ‘CREATING’ or ‘READY’.

config string

The name of the instance’s configuration (similar but not quite the same as a region) which defines 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.

displayName string

The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

labels {[key: string]: string}

An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

name string

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.

numNodes number

The number of nodes allocated to this instance.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

state string

Instance status: ‘CREATING’ or ‘READY’.

config str

The name of the instance’s configuration (similar but not quite the same as a region) which defines 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.

display_name str

The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

labels Dict[str, str]

An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

name str

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.

num_nodes float

The number of nodes allocated to this instance.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

state str

Instance status: ‘CREATING’ or ‘READY’.

Package Details

Repository
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.