Cluster

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

A cluster instance.

interface Cluster {

allowFewerZonesDeployment?: boolean;

asyncClusterEndpointsDeletionEnabled?: boolean;

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

automatedBackupConfig?: AutomatedBackupConfig;

readonly backupCollection?: string;

clusterEndpoints?: ClusterEndpoint[];

readonly createTime?: Date;

crossClusterReplicationConfig?: CrossClusterReplicationConfig;

deletionProtectionEnabled?: boolean;

readonly discoveryEndpoints?: DiscoveryEndpoint[];

readonly encryptionInfo?: EncryptionInfo;

gcsSource?: GcsBackupSource;

kmsKey?: string;

maintenancePolicy?: ClusterMaintenancePolicy;

readonly maintenanceSchedule?: ClusterMaintenanceSchedule;

managedBackupSource?: ManagedBackupSource;

name?: string;

nodeType?:

| "NODE_TYPE_UNSPECIFIED"

| "REDIS_SHARED_CORE_NANO"

| "REDIS_HIGHMEM_MEDIUM"

| "REDIS_HIGHMEM_XLARGE"

| "REDIS_STANDARD_SMALL";

ondemandMaintenance?: boolean;

persistenceConfig?: ClusterPersistenceConfig;

readonly preciseSizeGb?: number;

pscConfigs?: PscConfig[];

readonly pscConnections?: PscConnection[];

readonly pscServiceAttachments?: PscServiceAttachment[];

redisConfigs?: {

[key: string]: string;

};

replicaCount?: number;

shardCount?: number;

simulateMaintenanceEvent?: boolean;

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;

zoneDistributionConfig?: ZoneDistributionConfig;

}

§Properties

allowFewerZonesDeployment?: boolean

[src]

Optional. Immutable. Allows customers to specify if they are okay with deploying a multi-zone cluster in less than 3 zones. Once set, if there is a zonal outage during the cluster creation, the cluster will only be deployed in 2 zones, and stay within the 2 zones for its lifecycle.

asyncClusterEndpointsDeletionEnabled?: boolean

[src]

Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted.

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.

automatedBackupConfig?: AutomatedBackupConfig

[src]

Optional. The automated backup config for the cluster.

readonly backupCollection?: string

[src]

Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}

clusterEndpoints?: ClusterEndpoint[]

[src]

Optional. A list of cluster endpoints.

readonly createTime?: Date

[src]

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

crossClusterReplicationConfig?: CrossClusterReplicationConfig

[src]

Optional. Cross cluster replication config.

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.

readonly encryptionInfo?: EncryptionInfo

[src]

Output only. Encryption information of the data at rest of the cluster.

gcsSource?: GcsBackupSource

[src]

Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects.

kmsKey?: string

[src]

Optional. The KMS key used to encrypt the at-rest data of the cluster.

maintenancePolicy?: ClusterMaintenancePolicy

[src]

Optional. ClusterMaintenancePolicy determines when to allow or deny updates.

readonly maintenanceSchedule?: ClusterMaintenanceSchedule

[src]

Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.

managedBackupSource?: ManagedBackupSource

[src]

Optional. Backups generated and managed by memorystore service.

name?: string

[src]

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

ondemandMaintenance?: boolean

[src]

Optional. Input only. Ondemand maintenance for the cluster. This field can be used to trigger ondemand critical update on the cluster.

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]

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.

readonly pscConnections?: PscConnection[]

[src]

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

readonly pscServiceAttachments?: PscServiceAttachment[]

[src]

Output only. Service attachment details to configure Psc connections

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]

Optional. Number of shards for the Redis cluster.

simulateMaintenanceEvent?: boolean

[src]

Optional. Input only. Simulate a maintenance event.

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.

zoneDistributionConfig?: ZoneDistributionConfig

[src]

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