.TH "GCLOUD_REDIS_CLUSTERS_CREATE" 1



.SH "NAME"
.HP
gcloud redis clusters create \- create a new Memorystore for Redis Cluster instance



.SH "SYNOPSIS"
.HP
\f5gcloud redis clusters create\fR (\fICLUSTER\fR\ :\ \fB\-\-region\fR=\fIREGION\fR) [\fB\-\-aof\-append\-fsync\fR=\fIAOF_APPEND_FSYNC\fR] [\fB\-\-async\fR] [\fB\-\-auth\-mode\fR=\fIAUTH_MODE\fR] [\fB\-\-automated\-backup\-mode\fR=\fIAUTOMATED_BACKUP_MODE\fR] [\fB\-\-automated\-backup\-start\-time\fR=\fIAUTOMATED_BACKUP_START_TIME\fR] [\fB\-\-automated\-backup\-ttl\fR=\fIAUTOMATED_BACKUP_TTL\fR] [\fB\-\-cross\-cluster\-replication\-role\fR=\fICROSS_CLUSTER_REPLICATION_ROLE\fR] [\fB\-\-deletion\-protection\fR] [\fB\-\-kms\-key\fR=\fIKMS_KEY\fR] [\fB\-\-maintenance\-window\-day\fR=\fIMAINTENANCE_WINDOW_DAY\fR] [\fB\-\-maintenance\-window\-hour\fR=\fIMAINTENANCE_WINDOW_HOUR\fR] [\fB\-\-network\fR=\fINETWORK\fR] [\fB\-\-node\-type\fR=\fINODE_TYPE\fR] [\fB\-\-persistence\-mode\fR=\fIPERSISTENCE_MODE\fR] [\fB\-\-primary\-cluster\fR=\fIPRIMARY_CLUSTER\fR] [\fB\-\-rdb\-snapshot\-period\fR=\fIRDB_SNAPSHOT_PERIOD\fR] [\fB\-\-rdb\-snapshot\-start\-time\fR=\fIRDB_SNAPSHOT_START_TIME\fR] [\fB\-\-redis\-config\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-replica\-count\fR=\fIREPLICA_COUNT\fR] [\fB\-\-shard\-count\fR=\fISHARD_COUNT\fR] [\fB\-\-transit\-encryption\-mode\fR=\fITRANSIT_ENCRYPTION_MODE\fR] [\fB\-\-zone\fR=\fIZONE\fR] [\fB\-\-zone\-distribution\-mode\fR=\fIZONE_DISTRIBUTION_MODE\fR] [\fB\-\-import\-gcs\-object\-uris\fR=[\fIIMPORT_GCS_OBJECT_URIS\fR,...]\ |\ \fB\-\-import\-managed\-backup\fR=\fIIMPORT_MANAGED_BACKUP\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Create a new Memorystore for Redis Cluster instance, and uses Private Service
Connect service connectivity automation to automate connectivity for instances.

This command can fail for the following reasons:
.RS 2m
.IP "\(bu" 2m
A cluster with the same name already exists.
.IP "\(bu" 2m
The active account does not have permission to create clusters.
.IP "\(bu" 2m
Some required APIs not enabled yet.
.IP "\(bu" 2m
No connection policy defined yet on the network and in the region a cluster will
be created.
.IP "\(bu" 2m
Miss the steps for creating and configuring a service account (to grant
permissions) in both host project and service project, if a shared VPC network
is used.
.RE
.sp

Refer to
https://cloud.google.com/memorystore/docs/cluster/networking#prerequisites_required_before_creating_a_cluster
for prerequisites.



.SH "EXAMPLES"

To create a cluster with name \f5my\-redis\-cluster\fR in region
\f5us\-central1\fR with 3 shards and with a discovery endpoint created on
network "default", run:

.RS 2m
$ gcloud redis clusters create my\-redis\-cluster \e
    \-\-region=us\-central1 \-\-shard\-count=3 \e
    \-\-network=projects/NETWORK_PROJECT_ID/global/networks/default
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Cluster resource \- Arguments and flags that specify the cluster you want to
create. Your cluster ID must be 1 to 63 characters and use only lowercase
letters, numbers, or hyphens. It must start with a lowercase letter and end with
a lowercase letter or number. The arguments in this group can be used to specify
the attributes of this resource. (NOTE) Some attributes are not given arguments
in this group but can be set in other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5cluster\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fICLUSTER\fR

ID of the cluster or fully qualified identifier for the cluster.

To set the \f5cluster\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5cluster\fR on the command line.
.RE
.sp

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

.TP 2m
\fB\-\-region\fR=\fIREGION\fR

The name of the Redis region of the cluster. Overrides the default redis/region
property value for this command invocation.


To set the \f5region\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5cluster\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-region\fR on the command line;
.IP "\(bu" 2m
set the property \f5redis/region\fR.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-aof\-append\-fsync\fR=\fIAOF_APPEND_FSYNC\fR

Fsync configuration. \fIAOF_APPEND_FSYNC\fR must be one of:

.RS 2m
.TP 2m
\fBalways\fR
Redis explicitly calls fsync for every write command.

.TP 2m
\fBeverysec\fR
(default) Redis explicitly calls fsync every second.

.TP 2m
\fBno\fR
Redis will not explicitly call fsync.

.RE
.sp


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

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

.TP 2m
\fB\-\-auth\-mode\fR=\fIAUTH_MODE\fR

Available authorization mode of a Redis cluster. \fIAUTH_MODE\fR must be one of:

.RS 2m
.TP 2m
\fBdisabled\fR
Authorization is disabled for the cluster.

.TP 2m
\fBiam\-auth\fR
IAM basic authorization is enabled for the cluster.

.RE
.sp


.TP 2m
\fB\-\-automated\-backup\-mode\fR=\fIAUTOMATED_BACKUP_MODE\fR

Automated backup mode. \fIAUTOMATED_BACKUP_MODE\fR must be one of:

.RS 2m
.TP 2m
\fBdisabled\fR
(default) Automated backup is disabled.

.TP 2m
\fBenabled\fR
Automated backup is enabled.

.RE
.sp


.TP 2m
\fB\-\-automated\-backup\-start\-time\fR=\fIAUTOMATED_BACKUP_START_TIME\fR

One\-hour window when you want automated\-backup operations to start. Specify
the time in the format HH:00 on a 24\-hour cycle in UTC time.

.TP 2m
\fB\-\-automated\-backup\-ttl\fR=\fIAUTOMATED_BACKUP_TTL\fR

Time to live for automated backups. A backup will be deleted automatically after
the TTL is reached. It ranges from 1 day to 365 days. For example, "10d" for 10
days. If not specified, the default value is 35 days.

.TP 2m
\fB\-\-cross\-cluster\-replication\-role\fR=\fICROSS_CLUSTER_REPLICATION_ROLE\fR

The role of the cluster in cross cluster replication.
\fICROSS_CLUSTER_REPLICATION_ROLE\fR must be (only one value is supported):

.RS 2m
.TP 2m
\fBsecondary\fR
Create a secondary cluster.

.RE
.sp


.TP 2m
\fB\-\-deletion\-protection\fR

Enable deletion protection for the Redis Cluster. Use
\f5\-\-deletion\-protection\fR/\f5\-\-no\-deletion\-protection\fR to
enable/disable it.

.TP 2m
\fB\-\-kms\-key\fR=\fIKMS_KEY\fR

The resource name of the customer\-managed encryption key (CMEK) to use for the
cluster. It must use this format:
projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/CRYPTO_KEY.
The key must be in the same region as the cluster. Otherwise, the create
operation fails.

.TP 2m
\fB\-\-maintenance\-window\-day\fR=\fIMAINTENANCE_WINDOW_DAY\fR

Day of week when the window starts, e.g. \f5sunday\fR.
\fIMAINTENANCE_WINDOW_DAY\fR must be one of: \fBfriday\fR, \fBmonday\fR,
\fBsaturday\fR, \fBsunday\fR, \fBthursday\fR, \fBtuesday\fR, \fBwednesday\fR.

.TP 2m
\fB\-\-maintenance\-window\-hour\fR=\fIMAINTENANCE_WINDOW_HOUR\fR

Hour of day (\f50\fR to \f523\fR) for the start of maintenance window, in UTC
time zone.

.TP 2m
\fB\-\-network\fR=\fINETWORK\fR

The network used to create your instance. It must use the format:
projects/NETWORK_PROJECT_ID/global/networks/NETWORK_ID. The network ID used here
must match the network ID used by the service connection policy. Otherwise, the
create operation fails

.TP 2m
\fB\-\-node\-type\fR=\fINODE_TYPE\fR

Node Type of the redis cluster Node. \fINODE_TYPE\fR must be one of:
\fBredis\-highmem\-medium\fR, \fBredis\-highmem\-xlarge\fR,
\fBredis\-shared\-core\-nano\fR, \fBredis\-standard\-small\fR.

.TP 2m
\fB\-\-persistence\-mode\fR=\fIPERSISTENCE_MODE\fR

Operation mode for persistence. \fIPERSISTENCE_MODE\fR must be one of:

.RS 2m
.TP 2m
\fBaof\fR
AOF\-based persistence
.TP 2m
\fBdisabled\fR
Persistence mode is disabled
.TP 2m
\fBrdb\fR
RDB\-based persistence
.RE
.sp


.TP 2m
\fB\-\-primary\-cluster\fR=\fIPRIMARY_CLUSTER\fR

The primary cluster that the secondary cluster will replicate from. It must use
the format: projects/PROJECT_ID/locations/REGION/clusters/CLUSTER_ID. It must
refer to an existing cluster. Otherwise, the create operation fails.

.TP 2m
\fB\-\-rdb\-snapshot\-period\fR=\fIRDB_SNAPSHOT_PERIOD\fR

Attempted period between RDB snapshots. \fIRDB_SNAPSHOT_PERIOD\fR must be one
of:

.RS 2m
.TP 2m
\fB12h\fR
12 hours
.TP 2m
\fB1h\fR
1 hour
.TP 2m
\fB24h\fR
(default) 24 hours
.TP 2m
\fB6h\fR
6 hours
.RE
.sp


.TP 2m
\fB\-\-rdb\-snapshot\-start\-time\fR=\fIRDB_SNAPSHOT_START_TIME\fR

Date and time of the first snapshot in the ISO 1801 format, and alignment time
for future snapshots. For example, 2024\-01\-01T01:00:00Z. If not specified, the
current time will be used.

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

A list of Redis config KEY=VALUE pairs to set on the Redis Cluster according to
http://redis.io/topics/config. Currently the supported Redis configs are:

.RS 2m
maxmemory\-clients, maxmemory, maxmemory\-policy, notify\-keyspace\-events,
slowlog\-log\-slower\-than, maxclients.
.RE

.TP 2m
\fB\-\-replica\-count\fR=\fIREPLICA_COUNT\fR

The replica count of each shard.

.TP 2m
\fB\-\-shard\-count\fR=\fISHARD_COUNT\fR

The shard count of the cluster.

.TP 2m
\fB\-\-transit\-encryption\-mode\fR=\fITRANSIT_ENCRYPTION_MODE\fR

Transit encryption mode used for the Redis cluster. If not provided, encryption
is disabled for the cluster. \fITRANSIT_ENCRYPTION_MODE\fR must be one of:

.RS 2m
.TP 2m
\fBdisabled\fR
In\-transit encryption is disabled for the cluster.

.TP 2m
\fBserver\-authentication\fR
The cluster uses server managed encryption for in\-transit encryption.

.RE
.sp


.TP 2m
\fB\-\-zone\fR=\fIZONE\fR

The zone used to allocate the cluster nodes. Applicable only if the
zone\-distribution\-mode is set to single\-zone.

.TP 2m
\fB\-\-zone\-distribution\-mode\fR=\fIZONE_DISTRIBUTION_MODE\fR

Determines how the cluster nodes are distributed across zones.
\fIZONE_DISTRIBUTION_MODE\fR must be one of:

.RS 2m
.TP 2m
\fBmulti\-zone\fR
Allocate cluster nodes across multiple zones.

.TP 2m
\fBsingle\-zone\fR
Allocate cluster nodes in a single zone.

.RE
.sp


.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-import\-gcs\-object\-uris\fR=[\fIIMPORT_GCS_OBJECT_URIS\fR,...]

URIs of Google Cloud Storage objects to import from. For example,
\f5gs://bucket/folder/file1.rdb,gs://bucket/folder/file2.rdb\fR.

.TP 2m
\fB\-\-import\-managed\-backup\fR=\fIIMPORT_MANAGED_BACKUP\fR

Managed backup to import from. For example,
\f5projects/PROJECT_ID/locations/REGION/backupCollections/BACKUP_COLLECTION_ID/backups/BACKUP_ID\fR.


.RE
.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 "API REFERENCE"

This command uses the \fBredis/v1\fR API. The full documentation for this API
can be found at: https://cloud.google.com/memorystore/docs/redis/



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha redis clusters create
.RE

.RS 2m
$ gcloud beta redis clusters create
.RE