.TH "GCLOUD_ALPHA_SPANNER_INSTANCE\-CONFIGS_CREATE" 1



.SH "NAME"
.HP
gcloud alpha spanner instance\-configs create \- create a Cloud Spanner instance configuration



.SH "SYNOPSIS"
.HP
\f5gcloud alpha spanner instance\-configs create\fR \fIINSTANCE_CONFIG\fR (\fB\-\-base\-config\fR=\fIBASE_CONFIG\fR\ \fB\-\-replicas\fR=\fIlocation\fR=\fILOCATION\fR,\fItype\fR=\fITYPE\fR:[...]\ |\ [\fB\-\-clone\-config\fR=\fIINSTANCE_CONFIG\fR\ :\ \fB\-\-add\-replicas\fR=\fIlocation\fR=\fILOCATION\fR,\fItype\fR=\fITYPE\fR:[...]\ \fB\-\-skip\-replicas\fR=\fIlocation\fR=\fILOCATION\fR,\fItype\fR=\fITYPE\fR:[...]]) [\fB\-\-async\fR] [\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR] [\fB\-\-etag\fR=\fIETAG\fR] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-validate\-only\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Create a Cloud Spanner instance configuration.



.SH "EXAMPLES"

To create a custom Cloud Spanner instance configuration based on an existing
Google\-managed configuration (\f5nam3\fR) by adding a \f5READ_ONLY\fR type
replica in location \f5us\-east4\fR, run:

.RS 2m
$ gcloud alpha spanner instance\-configs create \e
    custom\-instance\-config \-\-clone\-config=nam3 \e
    \-\-add\-replicas=location=us\-east4,type=READ_ONLY
.RE

To create a custom Cloud Spanner instance configuration based on another custom
configuration (\f5custom\-instance\-config\fR) by adding a \f5READ_ONLY\fR type
replica in location \f5us\-east1\fR and removing a \f5READ_ONLY\fR type replica
in location \f5us\-east4\fR, run:

.RS 2m
$ gcloud alpha spanner instance\-configs create \e
    custom\-instance\-config1 \-\-clone\-config=custom\-instance\-config \e
    \-\-add\-replicas=location=us\-east1,type=READ_ONLY \e
    \-\-skip\-replicas=location=us\-east4,type=READ_ONLY
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
\fIINSTANCE_CONFIG\fR

Cloud Spanner instance configuration. The 'custom\-' prefix is required to avoid
name conflicts with Google\-managed configurations.


.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m

Exactly one of these must be specified:


.RS 2m
.TP 2m

Command\-line flags to setup a custom instance configuration replicas:


.RS 2m
.TP 2m
\fB\-\-base\-config\fR=\fIBASE_CONFIG\fR

The name of the Google\-managed instance configuration, based on which your
custom configuration is created.

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-replicas\fR=\fIlocation\fR=\fILOCATION\fR,\fItype\fR=\fITYPE\fR:[...]

The geographic placement of nodes in this instance configuration and their
replication types.

.RS 2m
.TP 2m
\fBlocation\fR
The location of the serving resources, e.g. "us\-central1".

.TP 2m
\fBtype\fR
The type of replica.

Items in the list are separated by ":". The allowed values and formats are as
follows.

.RE
.sp
.TP 2m
\fBREAD_ONLY\fR

Read\-only replicas only support reads (not writes). Read\-only replicas:

.RS 2m
.IP "\(em" 2m
Maintain a full copy of your data.
.RE
.sp

.RS 2m
.IP "\(em" 2m
Serve reads.
.RE
.sp

.RS 2m
.IP "\(em" 2m
Do not participate in voting to commit writes.
.RE
.sp

.RS 2m
.IP "\(em" 2m
Are not eligible to become a leader.
.RE
.sp

.TP 2m
\fBREAD_WRITE\fR

Read\-write replicas support both reads and writes. These replicas:

.RS 2m
.IP "\(em" 2m
Maintain a full copy of your data.
.RE
.sp

.RS 2m
.IP "\(em" 2m
Serve reads.
.RE
.sp

.RS 2m
.IP "\(em" 2m
Can vote whether to commit a write.
.RE
.sp

.RS 2m
.IP "\(em" 2m
Participate in leadership election.
.RE
.sp

.RS 2m
.IP "\(em" 2m
Are eligible to become a leader.
.RE
.sp

.TP 2m
\fBWITNESS\fR

Witness replicas don't support reads but do participate in voting to commit
writes. Witness replicas:

.RS 2m
.IP "\(em" 2m
Do not maintain a full copy of data.
.RE
.sp

.RS 2m
.IP "\(em" 2m
Do not serve reads.
.RE
.sp

.RS 2m
.IP "\(em" 2m
Vote whether to commit writes.
.RE
.sp

.RS 2m
.IP "\(em" 2m
Participate in leader election but are not eligible to become leader.
.RE
.sp

This flag argument must be specified if any of the other arguments in this group
are specified.

.RE
.sp
.TP 2m

Command\-line flags to setup a custom instance configuration using clone
options:


.RS 2m
.TP 2m
\fB\-\-clone\-config\fR=\fIINSTANCE_CONFIG\fR

The ID of the instance config, based on which this configuration is created. The
clone is an independent copy of this config. Available configurations can be
found by running "gcloud spanner instance\-configs list"

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-add\-replicas\fR=\fIlocation\fR=\fILOCATION\fR,\fItype\fR=\fITYPE\fR:[...]

Add new replicas while cloning from the source config.

.TP 2m
\fB\-\-skip\-replicas\fR=\fIlocation\fR=\fILOCATION\fR,\fItype\fR=\fITYPE\fR:[...]

Skip replicas from the source config while cloning. Each replica in the list
must exist in the source config replicas list.


.RE
.RE
.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR

The name of this instance configuration as it appears in UIs. Must specify this
option if creating an instance\-config with \-\-replicas.

.TP 2m
\fB\-\-etag\fR=\fIETAG\fR

Used for optimistic concurrency control.

.TP 2m
\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to add.

Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

.TP 2m
\fB\-\-validate\-only\fR

If specified, validate that the creation will succeed without creating the
instance configuration.


.RE
.sp

.SH "GCLOUD WIDE FLAGS"

These flags are available to all commands: \-\-access\-token\-file, \-\-account,
\-\-billing\-project, \-\-configuration, \-\-flags\-file, \-\-flatten,
\-\-format, \-\-help, \-\-impersonate\-service\-account, \-\-log\-http,
\-\-project, \-\-quiet, \-\-trace\-token, \-\-user\-output\-enabled,
\-\-verbosity.

Run \fB$ gcloud help\fR for details.



.SH "NOTES"

This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation\-only early access
allowlist. These variants are also available:

.RS 2m
$ gcloud spanner instance\-configs create
.RE

.RS 2m
$ gcloud beta spanner instance\-configs create
.RE