Cluster class

Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Constructors

Cluster(String name, {ClusterArgs? args, CustomResourceOptions? options})

Creates a new Cluster. name The Pulumi resource name. args Arguments used to configure this Cluster. The set of arguments for Cluster. options Resource options controlling this resource's behavior.

Properties

authorizationMode ↔ Output<String>

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

late, final

childResources → Set<Resource>

final, inherited

clusterId ↔ Output<String>

Required. The logical name of the Redis cluster in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the customer project / location

late, final

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

The timestamp associated with the cluster creation request.

late, final

discoveryEndpoints ↔ Output<List<Map<String, dynamic>>>

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

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

location ↔ Output<String>

late, final

name ↔ Output<String>

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

late, final

project ↔ Output<String>

late, final

pscConfigs ↔ Output<List<Map<String, dynamic>>>

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.

late, final

pscConnections ↔ Output<List<Map<String, dynamic>>>

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

late, final

replicaCount ↔ Output<int>

Optional. The number of replica nodes per shard.

late, final

requestId ↔ Output<String?>

Idempotent request UUID.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shardCount ↔ Output<int>

Number of shards for the Redis cluster.

late, final

sizeGb ↔ Output<int>

Redis memory size in GB for the entire cluster.

late, final

state ↔ Output<String>

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

late, final

stateInfo ↔ Output<StateInfoResponse>

Additional information about the current state of the cluster.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

transitEncryptionMode ↔ Output<String>

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

late, final

uid ↔ Output<String>

System assigned, unique identifier for the cluster.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited