gcp_redis_instance

alternative_location_id

Type: STRING
Provider name: alternativeLocationId
Description: 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.

ancestors

Type: UNORDERED_LIST_STRING

auth_enabled

Type: BOOLEAN
Provider name: authEnabled
Description: 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.

authorized_network

Type: STRING
Provider name: authorizedNetwork
Description: 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.

available_maintenance_versions

Type: UNORDERED_LIST_STRING
Provider name: availableMaintenanceVersions
Description: Optional. The available maintenance versions that an instance could update to.

connect_mode

Type: STRING
Provider name: connectMode
Description: Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
Possible values:

• CONNECT_MODE_UNSPECIFIED - Not set.
  
• DIRECT_PEERING - Connect via direct peering to the Memorystore for Redis hosted service.
  
• PRIVATE_SERVICE_ACCESS - Connect your Memorystore for Redis instance using Private Service Access. Private services access provides an IP address range for multiple Google Cloud services, including Memorystore.
  

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. The time the instance was created.

current_location_id

Type: STRING
Provider name: currentLocationId
Description: Output only. 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.

customer_managed_key

Type: STRING
Provider name: customerManagedKey
Description: Optional. The KMS key reference that the customer provides when trying to create the instance.

gcp_display_name

Type: STRING
Provider name: displayName
Description: An arbitrary and optional user-provided name for the instance.

host

Type: STRING
Provider name: host
Description: Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.

labels

Type: UNORDERED_LIST_STRING

location_id

Type: STRING
Provider name: locationId
Description: Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone.

maintenance_policy

Type: STRUCT
Provider name: maintenancePolicy
Description: Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.

• create_time
  Type: TIMESTAMP
  Provider name: createTime
  Description: Output only. The time when the policy was created.
  
• description
  Type: STRING
  Provider name: description
  Description: Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
  
• update_time
  Type: TIMESTAMP
  Provider name: updateTime
  Description: Output only. The time when the policy was last updated.
  
• weekly_maintenance_window
  Type: UNORDERED_LIST_STRUCT
  Provider name: weeklyMaintenanceWindow
  Description: Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_window is expected to be one.
  
  • day
    Type: STRING
    Provider name: day
    Description: Required. The day of week that maintenance updates occur.
    Possible values:
    
    • DAY_OF_WEEK_UNSPECIFIED - The day of the week is unspecified.
      
    • MONDAY - Monday
      
    • TUESDAY - Tuesday
      
    • WEDNESDAY - Wednesday
      
    • THURSDAY - Thursday
      
    • FRIDAY - Friday
      
    • SATURDAY - Saturday
      
    • SUNDAY - Sunday
      
  • duration
    Type: STRING
    Provider name: duration
    Description: Output only. Duration of the maintenance window. The current window is fixed at 1 hour.
    
  • start_time
    Type: STRUCT
    Provider name: startTime
    Description: Required. Start time of the window in UTC time.
    
    • hours
      Type: INT32
      Provider name: hours
      Description: Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value “24:00:00” for scenarios like business closing time.
      
    • minutes
      Type: INT32
      Provider name: minutes
      Description: Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
      
    • nanos
      Type: INT32
      Provider name: nanos
      Description: Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
      
    • seconds
      Type: INT32
      Provider name: seconds
      Description: Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
      

maintenance_schedule

Type: STRUCT
Provider name: maintenanceSchedule
Description: Output only. Date and time of upcoming maintenance events which have been scheduled.

• can_reschedule
  Type: BOOLEAN
  Provider name: canReschedule
  Description: If the scheduled maintenance can be rescheduled, default is true.
  
• end_time
  Type: TIMESTAMP
  Provider name: endTime
  Description: Output only. The end time of any upcoming scheduled maintenance for this instance.
  
• schedule_deadline_time
  Type: TIMESTAMP
  Provider name: scheduleDeadlineTime
  Description: Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.
  
• start_time
  Type: TIMESTAMP
  Provider name: startTime
  Description: Output only. The start time of any upcoming scheduled maintenance for this instance.
  

maintenance_version

Type: STRING
Provider name: maintenanceVersion
Description: Optional. The self service update maintenance version. The version is date based such as “20210712_00_00”.

memory_size_gb

Type: INT32
Provider name: memorySizeGb
Description: Required. Redis memory size in GiB.

name

Type: STRING
Provider name: name
Description: Required. 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.

nodes

Type: UNORDERED_LIST_STRUCT
Provider name: nodes
Description: Output only. Info per node.

• id
  Type: STRING
  Provider name: id
  Description: Output only. Node identifying string. e.g. ’node-0’, ’node-1’
  
• zone
  Type: STRING
  Provider name: zone
  Description: Output only. Location of the node.
  

organization_id

Type: STRING

parent

Type: STRING

persistence_config

Type: STRUCT
Provider name: persistenceConfig
Description: Optional. Persistence configuration parameters

• persistence_mode
  Type: STRING
  Provider name: persistenceMode
  Description: Optional. Controls whether Persistence features are enabled. If not provided, the existing value will be used.
  Possible values:
  
  • PERSISTENCE_MODE_UNSPECIFIED - Not set.
    
  • DISABLED - Persistence is disabled for the instance, and any existing snapshots are deleted.
    
  • RDB - RDB based Persistence is enabled.
    
• rdb_next_snapshot_time
  Type: TIMESTAMP
  Provider name: rdbNextSnapshotTime
  Description: Output only. The next time that a snapshot attempt is scheduled to occur.
  
• rdb_snapshot_period
  Type: STRING
  Provider name: rdbSnapshotPeriod
  Description: Optional. Period between RDB snapshots. Snapshots will be attempted every period starting from the provided snapshot start time. For example, a start time of 01/01/2033 06:45 and SIX_HOURS snapshot period will do nothing until 01/01/2033, and then trigger snapshots every day at 06:45, 12:45, 18:45, and 00:45 the next day, and so on. If not provided, TWENTY_FOUR_HOURS will be used as default.
  Possible values:
  
  • SNAPSHOT_PERIOD_UNSPECIFIED - Not set.
    
  • ONE_HOUR - Snapshot every 1 hour.
    
  • SIX_HOURS - Snapshot every 6 hours.
    
  • TWELVE_HOURS - Snapshot every 12 hours.
    
  • TWENTY_FOUR_HOURS - Snapshot every 24 hours.
    
• rdb_snapshot_start_time
  Type: TIMESTAMP
  Provider name: rdbSnapshotStartTime
  Description: Optional. Date and time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used.
  

persistence_iam_identity

Type: STRING
Provider name: persistenceIamIdentity
Description: Output only. 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.

port

Type: INT32
Provider name: port
Description: Output only. The port number of the exposed Redis endpoint.

project_id

Type: STRING

project_number

Type: STRING

read_endpoint

Type: STRING
Provider name: readEndpoint
Description: Output only. 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’.

read_endpoint_port

Type: INT32
Provider name: readEndpointPort
Description: Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target ‘port’.

read_replicas_mode

Type: STRING
Provider name: readReplicasMode
Description: Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.
Possible values:

• READ_REPLICAS_MODE_UNSPECIFIED - If not set, Memorystore Redis backend will default to READ_REPLICAS_DISABLED.
  
• READ_REPLICAS_DISABLED - If disabled, read endpoint will not be provided and the instance cannot scale up or down the number of replicas.
  
• READ_REPLICAS_ENABLED - If enabled, read endpoint will be provided and the instance can scale up and down the number of replicas. Not valid for basic tier.
  

redis_version

Type: STRING
Provider name: redisVersion
Description: Optional. The version of Redis software. If not provided, the default 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 * REDIS_5_0 for Redis 5.0 compatibility * REDIS_6_X for Redis 6.x compatibility * REDIS_7_0 for Redis 7.0 compatibility (default) * REDIS_7_2 for Redis 7.2 compatibility

replica_count

Type: INT32
Provider name: replicaCount
Description: 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.

reserved_ip_range

Type: STRING
Provider name: reservedIpRange
Description: 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.

resource_name

Type: STRING

satisfies_pzi

Type: BOOLEAN
Provider name: satisfiesPzi
Description: Optional. Output only. Reserved for future use.

satisfies_pzs

Type: BOOLEAN
Provider name: satisfiesPzs
Description: Optional. Output only. Reserved for future use.

secondary_ip_range

Type: STRING
Provider name: secondaryIpRange
Description: 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”.

server_ca_certs

Type: UNORDERED_LIST_STRUCT
Provider name: serverCaCerts
Description: Output only. List of server CA certificates for the instance.

• cert
  Type: STRING
  Provider name: cert
  Description: PEM representation.
  
• create_time
  Type: TIMESTAMP
  Provider name: createTime
  Description: Output only. The time when the certificate was created in RFC 3339 format, for example 2020-05-18T00:00:00.094Z.
  
• expire_time
  Type: TIMESTAMP
  Provider name: expireTime
  Description: Output only. The time when the certificate expires in RFC 3339 format, for example 2020-05-18T00:00:00.094Z.
  
• serial_number
  Type: STRING
  Provider name: serialNumber
  Description: Serial number, as extracted from the certificate.
  
• sha1_fingerprint
  Type: STRING
  Provider name: sha1Fingerprint
  Description: Sha1 Fingerprint of the certificate.
  

state

Type: STRING
Provider name: state
Description: Output only. The current state of this instance.
Possible values:

• STATE_UNSPECIFIED - Not set.
  
• CREATING - Redis instance is being created.
  
• READY - Redis instance has been created and is fully usable.
  
• UPDATING - Redis instance configuration is being updated. Certain kinds of updates may cause the instance to become unusable while the update is in progress.
  
• DELETING - Redis instance is being deleted.
  
• REPAIRING - Redis instance is being repaired and may be unusable.
  
• MAINTENANCE - Maintenance is being performed on this Redis instance.
  
• IMPORTING - Redis instance is importing data (availability may be affected).
  
• FAILING_OVER - Redis instance is failing over (availability may be affected).
  

status_message

Type: STRING
Provider name: statusMessage
Description: Output only. Additional information about the current status of this instance, if available.

suspension_reasons

Type: UNORDERED_LIST_STRING
Provider name: suspensionReasons
Description: Optional. reasons that causes instance in “SUSPENDED” state.

tags

Type: UNORDERED_LIST_STRING

tier

Type: STRING
Provider name: tier
Description: Required. The service tier of the instance.
Possible values:

• TIER_UNSPECIFIED - Not set.
  
• BASIC - BASIC tier: standalone instance
  
• STANDARD_HA - STANDARD_HA tier: highly available primary/replica instances
  

transit_encryption_mode

Type: STRING
Provider name: transitEncryptionMode
Description: Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.
Possible values:

• TRANSIT_ENCRYPTION_MODE_UNSPECIFIED - Not set.
  
• SERVER_AUTHENTICATION - Client to Server traffic encryption enabled with server authentication.
  
• DISABLED - TLS is disabled for the instance.