Cluster

import type { Cluster } from "https://googleapis.deno.dev/v1/redis:v1.ts";

A cluster instance.

interface Cluster {

authorizationMode?: "AUTH_MODE_UNSPECIFIED" | "AUTH_MODE_IAM_AUTH" | "AUTH_MODE_DISABLED";

readonly createTime?: Date;

deletionProtectionEnabled?: boolean;

readonly discoveryEndpoints?: DiscoveryEndpoint[];

name?: string;

nodeType?:

| "NODE_TYPE_UNSPECIFIED"

| "REDIS_SHARED_CORE_NANO"

| "REDIS_HIGHMEM_MEDIUM"

| "REDIS_HIGHMEM_XLARGE"

| "REDIS_STANDARD_SMALL";

persistenceConfig?: ClusterPersistenceConfig;

readonly preciseSizeGb?: number;

pscConfigs?: PscConfig[];

readonly pscConnections?: PscConnection[];

redisConfigs?: {

[key: string]: string;

};

replicaCount?: number;

shardCount?: number;

readonly sizeGb?: number;

readonly state?:

| "STATE_UNSPECIFIED"

| "CREATING"

| "ACTIVE"

| "UPDATING"

| "DELETING";

readonly stateInfo?: StateInfo;

transitEncryptionMode?: "TRANSIT_ENCRYPTION_MODE_UNSPECIFIED" | "TRANSIT_ENCRYPTION_MODE_DISABLED" | "TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION";

readonly uid?: string;

}

§Properties

authorizationMode?: "AUTH_MODE_UNSPECIFIED" | "AUTH_MODE_IAM_AUTH" | "AUTH_MODE_DISABLED"

[src]

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

readonly createTime?: Date

[src]

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

deletionProtectionEnabled?: boolean

[src]

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

readonly discoveryEndpoints?: DiscoveryEndpoint[]

[src]

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

name?: string

[src]

Required. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}

nodeType?: "NODE_TYPE_UNSPECIFIED" | "REDIS_SHARED_CORE_NANO" | "REDIS_HIGHMEM_MEDIUM" | "REDIS_HIGHMEM_XLARGE" | "REDIS_STANDARD_SMALL"

[src]

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

persistenceConfig?: ClusterPersistenceConfig

[src]

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

readonly preciseSizeGb?: number

[src]

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

pscConfigs?: PscConfig[]

[src]

Required. 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.

readonly pscConnections?: PscConnection[]

[src]

Output only. PSC connections for discovery of the cluster topology and accessing the cluster.

redisConfigs?: {

[key: string]: string;

}

[src]

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

replicaCount?: number

[src]

Optional. The number of replica nodes per shard.

shardCount?: number

[src]

Required. Number of shards for the Redis cluster.

readonly sizeGb?: number

[src]

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

readonly state?: "STATE_UNSPECIFIED" | "CREATING" | "ACTIVE" | "UPDATING" | "DELETING"

[src]

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

readonly stateInfo?: StateInfo

[src]

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

transitEncryptionMode?: "TRANSIT_ENCRYPTION_MODE_UNSPECIFIED" | "TRANSIT_ENCRYPTION_MODE_DISABLED" | "TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION"

[src]

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

readonly uid?: string

[src]

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