REST Resource: projects.locations.clusters

{
  "name": string,
  "createTime": string,
  "state": enum (State),
  "uid": string,
  "authorizationMode": enum (AuthorizationMode),
  "transitEncryptionMode": enum (TransitEncryptionMode),
  "pscConfigs": [
    {
      object (PscConfig)
    }
  ],
  "discoveryEndpoints": [
    {
      object (DiscoveryEndpoint)
    }
  ],
  "pscConnections": [
    {
      object (PscConnection)
    }
  ],
  "stateInfo": {
    object (StateInfo)
  },
  "nodeType": enum (NodeType),
  "persistenceConfig": {
    object (ClusterPersistenceConfig)
  },
  "redisConfigs": {
    string: string,
    ...
  },
  "zoneDistributionConfig": {
    object (ZoneDistributionConfig)
  },
  "crossClusterReplicationConfig": {
    object (CrossClusterReplicationConfig)
  },
  "pscServiceAttachments": [
    {
      object (PscServiceAttachment)
    }
  ],
  "clusterEndpoints": [
    {
      object (ClusterEndpoint)
    }
  ],
  "replicaCount": integer,
  "sizeGb": integer,
  "shardCount": integer,
  "preciseSizeGb": number,
  "deletionProtectionEnabled": boolean,
  "maintenancePolicy": {
    object (ClusterMaintenancePolicy)
  },
  "maintenanceSchedule": {
    object (ClusterMaintenanceSchedule)
  }
}

string

Required. Identifier. Unique name of the resource in this scope including project and location using the form: projects/{projectId}/locations/{locationId}/clusters/{clusterId}

string (Timestamp format)

Output only. The timestamp associated with the cluster creation request.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

enum (State)

Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED

string

Output only. System assigned, unique identifier for the cluster.

enum (AuthorizationMode)

Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.

enum (TransitEncryptionMode)

Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.

object (PscConfig)

Optional. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.

object (DiscoveryEndpoint)

Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.

object (PscConnection)

Output only. The list of PSC connections that are auto-created through service connectivity automation.

object (StateInfo)

Output only. Additional information about the current state of the cluster.

enum (NodeType)

Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.

object (ClusterPersistenceConfig)

Optional. Persistence config (RDB, AOF) for the cluster.

map (key: string, value: string)

Optional. Key/Value pairs of customer overrides for mutable Redis Configs

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

object (ZoneDistributionConfig)

Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region.

object (CrossClusterReplicationConfig)

Optional. Cross cluster replication config.

object (PscServiceAttachment)

Output only. Service attachment details to configure Psc connections

object (ClusterEndpoint)

Optional. A list of cluster enpoints.

integer

Optional. The number of replica nodes per shard.

integer

Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.

integer

Optional. Number of shards for the Redis cluster.

number

Output only. Precise value of redis memory size in GB for the entire cluster.

boolean

Optional. The delete operation will fail when the value is set to true.

object (ClusterMaintenancePolicy)

Optional. ClusterMaintenancePolicy determines when to allow or deny updates.

object (ClusterMaintenanceSchedule)

Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.

{
  "network": string
}

string

Required. The network where the IP address of the discovery endpoint will be reserved, in the form of projects/{networkProject}/global/networks/{network_id}.

{
  "address": string,
  "port": integer,
  "pscConfig": {
    object (PscConfig)
  }
}

string

Output only. Address of the exposed Redis endpoint used by clients to connect to the service. The address could be either IP or hostname.

integer

Output only. The port number of the exposed Redis endpoint.

object (PscConfig)

Output only. Customer configuration for where the endpoint is created and accessed from.

{
  "pscConnectionId": string,
  "address": string,
  "forwardingRule": string,
  "projectId": string,
  "network": string,
  "serviceAttachment": string,
  "pscConnectionStatus": enum (PscConnectionStatus),
  "connectionType": enum (ConnectionType)
}

string

Required. The PSC connection id of the forwarding rule connected to the service attachment.

string

Required. The IP allocated on the consumer network for the PSC forwarding rule.

string

Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.

string

Optional. Project ID of the consumer project where the forwarding rule is created in.

string

Required. The consumer network where the IP address resides, in the form of projects/{projectId}/global/networks/{network_id}.

string

Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}.

enum (PscConnectionStatus)

Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details.

enum (ConnectionType)

Output only. Type of the PSC connection.

{

  // Union field info can be only one of the following:
  "updateInfo": {
    object (UpdateInfo)
  }
  // End of list of possible types for union field info.
}

object (UpdateInfo)

Describes ongoing update on the cluster when cluster state is UPDATING.

{
  "targetShardCount": integer,
  "targetReplicaCount": integer
}

integer

Target number of shards for redis cluster

integer

Target number of replica nodes per shard.

{
  "mode": enum (PersistenceMode),
  "rdbConfig": {
    object (RDBConfig)
  },
  "aofConfig": {
    object (AOFConfig)
  }
}

enum (PersistenceMode)

Optional. The mode of persistence.

object (RDBConfig)

Optional. RDB configuration. This field will be ignored if mode is not RDB.

object (AOFConfig)

Optional. AOF configuration. This field will be ignored if mode is not AOF.

{
  "rdbSnapshotPeriod": enum (SnapshotPeriod),
  "rdbSnapshotStartTime": string
}

enum (SnapshotPeriod)

Optional. Period between RDB snapshots.

string (Timestamp format)

Optional. The time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

{
  "appendFsync": enum (AppendFsync)
}

enum (AppendFsync)

Optional. fsync configuration.

{
  "mode": enum (ZoneDistributionMode),
  "zone": string
}

enum (ZoneDistributionMode)

Optional. The mode of zone distribution. Defaults to MULTI_ZONE, when not specified.

string

Optional. When SINGLE ZONE distribution is selected, zone field would be used to allocate all resources in that zone. This is not applicable to MULTI_ZONE, and would be ignored for MULTI_ZONE clusters.

{
  "clusterRole": enum (ClusterRole),
  "primaryCluster": {
    object (RemoteCluster)
  },
  "secondaryClusters": [
    {
      object (RemoteCluster)
    }
  ],
  "updateTime": string,
  "membership": {
    object (Membership)
  }
}

enum (ClusterRole)

The role of the cluster in cross cluster replication.

object (RemoteCluster)

Details of the primary cluster that is used as the replication source for this secondary cluster.

This field is only set for a secondary cluster.

object (RemoteCluster)

List of secondary clusters that are replicating from this primary cluster.

This field is only set for a primary cluster.

string (Timestamp format)

Output only. The last time cross cluster replication config was updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

object (Membership)

Output only. An output only view of all the member clusters participating in the cross cluster replication. This view will be provided by every member cluster irrespective of its cluster role(primary or secondary).

A primary cluster can provide information about all the secondary clusters replicating from it. However, a secondary cluster only knows about the primary cluster from which it is replicating. However, for scenarios, where the primary cluster is unavailable(e.g. regional outage), a clusters.get request can be sent to any other member cluster and this field will list all the member clusters participating in cross cluster replication.

{
  "cluster": string,
  "uid": string
}

string

The full resource path of the remote cluster in the format: projects//locations//clusters/

string

Output only. The unique identifier of the remote cluster.

{
  "primaryCluster": {
    object (RemoteCluster)
  },
  "secondaryClusters": [
    {
      object (RemoteCluster)
    }
  ]
}

object (RemoteCluster)

Output only. The primary cluster that acts as the source of replication for the secondary clusters.

object (RemoteCluster)

Output only. The list of secondary clusters replicating from the primary cluster.

{
  "createTime": string,
  "updateTime": string,
  "weeklyMaintenanceWindow": [
    {
      object (ClusterWeeklyMaintenanceWindow)
    }
  ]
}

string (Timestamp format)

Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

string (Timestamp format)

Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

object (ClusterWeeklyMaintenanceWindow)

Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weeklyMaintenanceWindow is expected to be one.

{
  "day": enum (DayOfWeek),
  "startTime": {
    object (TimeOfDay)
  }
}

enum (DayOfWeek)

Allows to define schedule that runs specified day of the week.

object (TimeOfDay)

Start time of the window in UTC.

{
  "startTime": string,
  "endTime": string
}

string (Timestamp format)

Output only. The start time of any upcoming scheduled maintenance for this instance.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

string (Timestamp format)

Output only. The end time of any upcoming scheduled maintenance for this instance.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

{
  "serviceAttachment": string,
  "connectionType": enum (ConnectionType)
}

string

Output only. Service attachment URI which your self-created PscConnection should use as target

enum (ConnectionType)

Output only. Type of a PSC connection targeting this service attachment.

{
  "connections": [
    {
      object (ConnectionDetail)
    }
  ]
}

object (ConnectionDetail)

A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster.

{

  // Union field connection can be only one of the following:
  "pscConnection": {
    object (PscConnection)
  }
  // End of list of possible types for union field connection.
}

object (PscConnection)

Detailed information of a PSC connection that is created by the customer who owns the cluster.