Instance class

Creates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project's default network. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Constructors

Instance(String name, {InstanceArgs? args, CustomResourceOptions? options})

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

Properties

alternativeLocationId ↔ Output<String>

Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in location_id. Additional nodes beyond the first 2 will be placed in zones selected by the service.

late, final

authEnabled ↔ Output<bool>

Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled.

late, final

authorizedNetwork ↔ Output<String>

Optional. The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.

late, final

availableMaintenanceVersions ↔ Output<List<String>>

Optional. The available maintenance versions that an instance could update to.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

connectMode ↔ Output<String>

Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.

late, final

createTime ↔ Output<String>

The time the instance was created.

late, final

currentLocationId ↔ Output<String>

The current zone where the Redis primary node is located. In basic tier, this will always be the same as location_id. In standard tier, this can be the zone of any node in the instance.

late, final

customerManagedKey ↔ Output<String>

Optional. The KMS key reference that the customer provides when trying to create the instance.

late, final

displayName ↔ Output<String>

An arbitrary and optional user-provided name for the instance.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

host ↔ Output<String>

Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.

late, final

id ↔ Output<String>

getter/setter pair, inherited

instanceId ↔ Output<String>

Required. The logical name of the Redis instance 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-40 characters. * Must end with a number or a letter. * Must be unique within the customer project / location

late, final

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

labels ↔ Output<Map<String, String>>

Resource labels to represent user provided metadata

late, final

location ↔ Output<String>

late, final

maintenancePolicy ↔ Output<MaintenancePolicyResponse>

Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.

late, final

maintenanceSchedule ↔ Output<MaintenanceScheduleResponse>

Date and time of upcoming maintenance events which have been scheduled.

late, final

maintenanceVersion ↔ Output<String>

Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".

late, final

memorySizeGb ↔ Output<int>

Redis memory size in GiB.

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}/instances/{instance_id} Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details.

late, final

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

Info per node.

late, final

persistenceConfig ↔ Output<PersistenceConfigResponse>

Optional. Persistence configuration parameters

late, final

persistenceIamIdentity ↔ Output<String>

Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:". The value may change over time for a given instance so should be checked before each import/export operation.

late, final

port ↔ Output<int>

The port number of the exposed Redis endpoint.

late, final

project ↔ Output<String>

late, final

readEndpoint ↔ Output<String>

Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'.

late, final

readEndpointPort ↔ Output<int>

The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.

late, final

readReplicasMode ↔ Output<String>

Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.

late, final

redisConfigs ↔ Output<Map<String, String>>

Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries

late, final

redisVersion ↔ Output<String>

Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * REDIS_3_2 for Redis 3.2 compatibility * REDIS_4_0 for Redis 4.0 compatibility (default) * REDIS_5_0 for Redis 5.0 compatibility * REDIS_6_X for Redis 6.x compatibility

late, final

replicaCount ↔ Output<int>

Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is 1-5 and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0.

late, final

reservedIpRange ↔ Output<String>

Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28.

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

satisfiesPzs ↔ Output<bool>

Optional. Output only. Reserved for future use. Zone Separation compliance state of the instance. Field name and documentation is obfuscated according to go/zs-resource-status.

late, final

secondaryIpRange ↔ Output<String>

Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto".

late, final

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

List of server CA certificates for the instance.

late, final

state ↔ Output<String>

The current state of this instance.

late, final

statusMessage ↔ Output<String>

Additional information about the current status of this instance, if available.

late, final

suspensionReasons ↔ Output<List<String>>

Optional. reasons that causes instance in "SUSPENDED" state.

late, final

tier ↔ Output<String>

The service tier of the instance.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

transitEncryptionMode ↔ Output<String>

Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.

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