google_api_redis v0.17.0 GoogleApi.Redis.V1beta1.Model.Instance View Source
A Google Cloud Redis instance.
Attributes
alternativeLocationId
(type:String.t
, default:nil
) - Optional. Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in location_id.authorizedNetwork
(type:String.t
, default:nil
) - Optional. The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, thedefault
network will be used.connectMode
(type:String.t
, default:nil
) - Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.createTime
(type:DateTime.t
, default:nil
) - Output only. The time the instance was created.currentLocationId
(type:String.t
, default:nil
) - Output only. The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the location_id provided by the user at creation time. For Standard Tier instances, this can be either location_id or alternative_location_id and can change after a failover event.displayName
(type:String.t
, default:nil
) - An arbitrary and optional user-provided name for the instance.host
(type:String.t
, default:nil
) - Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.labels
(type:map()
, default:nil
) - Resource labels to represent user provided metadatalocationId
(type:String.t
, default:nil
) - Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If alternative_location_id is also provided, it must be different from location_id.memorySizeGb
(type:integer()
, default:nil
) - Required. Redis memory size in GiB.name
(type:String.t
, default:nil
) - 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.
persistenceIamIdentity
(type:String.t
, default:nil
) - Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:<service_account_email>". The value may change over time for a given instance so should be checked before each import/export operation.port
(type:integer()
, default:nil
) - Output only. The port number of the exposed Redis endpoint.redisConfigs
(type:map()
, default:nil
) - 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
redisVersion
(type:String.t
, default:nil
) - 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
-
reservedIpRange
(type:String.t
, default:nil
) - Optional. The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network.state
(type:String.t
, default:nil
) - Output only. The current state of this instance.statusMessage
(type:String.t
, default:nil
) - Output only. Additional information about the current status of this instance, if available.tier
(type:String.t
, default:nil
) - Required. The service tier of the instance.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
Specs
t() :: %GoogleApi.Redis.V1beta1.Model.Instance{ alternativeLocationId: String.t(), authorizedNetwork: String.t(), connectMode: String.t(), createTime: DateTime.t(), currentLocationId: String.t(), displayName: String.t(), host: String.t(), labels: map(), locationId: String.t(), memorySizeGb: integer(), name: String.t(), persistenceIamIdentity: String.t(), port: integer(), redisConfigs: map(), redisVersion: String.t(), reservedIpRange: String.t(), state: String.t(), statusMessage: String.t(), tier: String.t() }
Link to this section Functions
Specs
Unwrap a decoded JSON object into its complex fields.