Class Instance (2.1.1)

Version 2.1.1

• 2.16.1 (latest)
• 2.16.0
• 2.15.5
• 2.14.0
• 2.13.1
• 2.12.1
• 2.11.1
• 2.10.0
• 2.9.3
• 2.8.1
• 2.7.1
• 2.6.0
• 2.5.1
• 2.4.1
• 2.3.0
• 2.2.4
• 2.1.1
• 2.0.0
• 1.0.2
• 0.4.0
• 0.3.0

Instance(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A Google Cloud Redis instance. .. attribute:: name

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.

:type: str

Attributes
Name	Description
display_name	str An arbitrary and optional user-provided name for the instance.
labels	Sequence[google.cloud.redis_v1beta1.types.Instance.LabelsEntry] Resource labels to represent user provided metadata
location_id	str 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.
alternative_location_id	str 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.
redis_version	str 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
reserved_ip_range	str 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.
host	str Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
port	int Output only. The port number of the exposed Redis endpoint.
current_location_id	str 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.
create_time	google.protobuf.timestamp_pb2.Timestamp Output only. The time the instance was created.
state	google.cloud.redis_v1beta1.types.Instance.State Output only. The current state of this instance.
status_message	str Output only. Additional information about the current status of this instance, if available.
redis_configs	Sequence[google.cloud.redis_v1beta1.types.Instance.RedisConfigsEntry] 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
tier	google.cloud.redis_v1beta1.types.Instance.Tier Required. The service tier of the instance.
memory_size_gb	int Required. Redis memory size in GiB.
authorized_network	str 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.
persistence_iam_identity	str Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:
connect_mode	google.cloud.redis_v1beta1.types.Instance.ConnectMode Optional. The connect mode of Redis instance. If not provided, default one will be used. Current default: DIRECT_PEERING.

Classes

ConnectMode

ConnectMode(value)

Available connection modes.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

RedisConfigsEntry

RedisConfigsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

State

State(value)

Represents the different states of a Redis instance.

Tier

Tier(value)

Available service tiers to choose from