GoogleRedisInstance class final

Factory wrapper for google_redis_instance.

A Google Cloud Redis instance.

Memorystore for Redis instance — managed Redis for app caches and sessions.

Pair with GoogleVpcAccessConnector (Cloud Run) or GCE/GKE workloads on the same VPC via authorizedNetwork.

Required identity:

localName: Terraform local name.
name: instance ID.
memorySizeGb: memory size in GiB.

Optional hardening / operations:

authEnabled turns Redis AUTH on (read the password via authString).
transitEncryptionMode enables in-transit TLS (serverCaCerts).
replicaCount / readReplicasMode add read replicas on STANDARD_HA instances (readEndpoint, readEndpointPort).
maintenancePolicy pins the weekly maintenance window.
persistenceConfig turns on RDB snapshots.

Enable redis.googleapis.com via GoogleProjectService or StackApis.enableApis before apply.

Example (basic tier on the default VPC):

GoogleRedisInstance(
  'cache',
  name: TfArg.literal('api-cache'),
  memorySizeGb: TfArg.literal(1),
  region: TfArg.literal('us-central1'),
  tier: RedisInstanceTier.basic,
  authorizedNetwork: .literal('default'),
);

Inheritance

Object
Resource
GoogleRedisInstance

Constructors

GoogleRedisInstance(String localName, {required TfArg<String> name, required TfArg<num> memorySizeGb, TfArg<String>? region, RedisInstanceTier? tier, RefTo<GoogleComputeNetwork>? authorizedNetwork, RedisInstanceConnectMode? connectMode, TfArg<bool>? authEnabled, RedisInstanceTransitEncryptionMode? transitEncryptionMode, TfArg<num>? replicaCount, RedisInstanceReadReplicasMode? readReplicasMode, TfArg<String>? redisVersion, TfArg<String>? displayName, TfArg<Map<String, String>>? labels, TfArg<bool>? deletionProtection, RedisInstanceMaintenancePolicy? maintenancePolicy, RedisInstancePersistenceConfig? persistenceConfig, LifecycleOptions? lifecycle, List<TfAddressed>? dependsOn, StackProvider? provider, TfTimeouts? timeouts})

Properties

alternativeLocationId → TfRef<String>: Reference to alternative_location_id attribute.
no setter
argMap → Map<String, TfArg?>: Argument-name → TfArg map. Keys are snake_case (Terraform JSON name). Synth emits these keys directly; the factory is responsible for the camelCase → snake_case translation at construction time.
finalinherited
authEnabled → TfRef<bool>: Reference to auth_enabled attribute.
no setter
authorizedNetwork → TfRef<String>: Reference to authorized_network attribute.
no setter
authString → TfRef<String>: Reference to auth_string attribute.
no setter
connectMode → TfRef<String>: Reference to connect_mode attribute.
no setter
createTime → TfRef<String>: Reference to create_time attribute.
no setter
currentLocationId → TfRef<String>: Reference to current_location_id attribute.
no setter
customerManagedKey → TfRef<String>: Reference to customer_managed_key attribute.
no setter
defaultProvider → String: The provider name a block without provider uses: by default the prefix of terraformType (google for google_pubsub_topic).
no setterinherited
deletionPolicy → TfRef<String>: Reference to deletion_policy attribute.
no setter
deletionProtection → TfRef<bool>: Reference to deletion_protection attribute.
no setter
dependsOn → List<TfAddressed>?: Optional depends_on = [...]: the resources, data sources and module calls this block waits for, e.g. dependsOn: [api, ...apiDeps]. Terraform takes whole blocks only, so an entry is never an attribute.
finalinherited
displayName → TfRef<String>: Reference to display_name attribute.
no setter
effectiveLabels → TfRef<Map<String, String>>: Reference to effective_labels attribute.
no setter
effectiveReservedIpRange → TfRef<String>: Reference to effective_reserved_ip_range attribute.
no setter
hashCode → int: The hash code for this object.
no setterinherited
host → TfRef<String>: Reference to host attribute.
no setter
id → TfRef<String>: Reference to id attribute.
no setter
kind → ResourceKind: Always ResourceKind.resource. Overridden by Data.
no setterinherited
labels → TfRef<Map<String, String>>: Reference to labels attribute.
no setter
lifecycle → LifecycleOptions?: Optional lifecycle { ... } block.
finalinherited
localName → String: User-supplied local name within a Stack.
finalinherited
locationId → TfRef<String>: Reference to location_id attribute.
no setter
maintenanceSchedule → TfRef<List<Map<String, Object?>>>: Reference to maintenance_schedule attribute.
no setter
maintenanceVersion → TfRef<String>: Reference to maintenance_version attribute.
no setter
memorySizeGb → TfRef<num>: Reference to memory_size_gb attribute.
no setter
name → TfRef<String>: Reference to name attribute.
no setter
nodes → TfRef<List<Map<String, Object?>>>: Reference to nodes attribute.
no setter
persistenceIamIdentity → TfRef<String>: Reference to persistence_iam_identity attribute.
no setter
port → TfRef<num>: Reference to port attribute.
no setter
project → TfRef<String>: Reference to project attribute.
no setter
provider → StackProvider?: Optional Terraform provider meta-argument: the provider configuration this block uses, e.g. the aliased GoogleProvider(alias: 'eu') the Stack registered with addProvider.
finalinherited
readEndpoint → TfRef<String>: Reference to read_endpoint attribute.
no setter
readEndpointPort → TfRef<num>: Reference to read_endpoint_port attribute.
no setter
readReplicasMode → TfRef<String>: Reference to read_replicas_mode attribute.
no setter
redisConfigs → TfRef<Map<String, String>>: Reference to redis_configs attribute.
no setter
redisVersion → TfRef<String>: Reference to redis_version attribute.
no setter
ref → RefTo<GoogleRedisInstance>: A reference to this resource, for arguments typed RefTo<GoogleRedisInstance>.
no setter
region → TfRef<String>: Reference to region attribute.
no setter
replicaCount → TfRef<num>: Reference to replica_count attribute.
no setter
reservedIpRange → TfRef<String>: Reference to reserved_ip_range attribute.
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
secondaryIpRange → TfRef<String>: Reference to secondary_ip_range attribute.
no setter
sensitiveFields → Set<String>: Field names that are @Sensitive per the IR-derived per-resource constant. Curated factories override with a baked-in static const Set<String> (file-private in v0.5+).
no setteroverride
serverCaCerts → TfRef<List<Map<String, Object?>>>: Reference to server_ca_certs attribute.
no setter
supportsDeletionProtection → bool: Capability flag: true when this resource's underlying Terraform schema has a deletion_protection boolean attribute that the synth-time devMode flow can flip to false. Defaults to false; the codegen emitter overrides this to true for wrappers whose schema includes the attribute.
no setteroverride
terraformLabels → TfRef<Map<String, String>>: Reference to terraform_labels attribute.
no setter
terraformType → String: Terraform resource type, e.g. google_pubsub_topic.
finalinherited
tfAddress → String: Terraform address <terraformType>.<localName>, e.g. google_pubsub_topic.orders.
no setterinherited
tier → TfRef<String>: Reference to tier attribute.
no setter
timeouts → TfTimeouts?: Optional timeouts { ... } block: how long Terraform waits for each operation. Provider-neutral like lifecycle — synth copies the duration strings verbatim, and terraform validate decides whether this resource's schema declares the operations set here.
finalinherited
transitEncryptionMode → TfRef<String>: Reference to transit_encryption_mode attribute.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Constants

tfType → const String