Class Instance (0.5.0)

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

Attributes

Name Description
name str
Identifier. Unique name of the instance. Format: projects/{project}/locations/{location}/instances/{instance}
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. Creation timestamp of the instance.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. Latest update timestamp of the instance.
labels MutableMapping[str, str]
Optional. Labels to represent user-provided metadata.
state google.cloud.memorystore_v1beta.types.Instance.State
Output only. Current state of the instance.
state_info google.cloud.memorystore_v1beta.types.Instance.StateInfo
Output only. Additional information about the state of the instance.
uid str
Output only. System assigned, unique identifier for the instance.
replica_count int
Optional. Number of replica nodes per shard. If omitted the default is 0 replicas. This field is a member of oneof_ _replica_count.
authorization_mode google.cloud.memorystore_v1beta.types.Instance.AuthorizationMode
Optional. Immutable. Authorization mode of the instance.
transit_encryption_mode google.cloud.memorystore_v1beta.types.Instance.TransitEncryptionMode
Optional. Immutable. In-transit encryption mode of the instance.
shard_count int
Optional. Number of shards for the instance.
discovery_endpoints MutableSequence[google.cloud.memorystore_v1beta.types.DiscoveryEndpoint]
Output only. Endpoints clients can connect to the instance through. Currently only one discovery endpoint is supported.
node_type google.cloud.memorystore_v1beta.types.Instance.NodeType
Optional. Immutable. Machine type for individual nodes of the instance.
persistence_config google.cloud.memorystore_v1beta.types.PersistenceConfig
Optional. Persistence configuration of the instance.
engine_version str
Optional. Immutable. Engine version of the instance.
engine_configs MutableMapping[str, str]
Optional. User-provided engine configurations for the instance.
node_config google.cloud.memorystore_v1beta.types.NodeConfig
Output only. Configuration of individual nodes of the instance.
zone_distribution_config google.cloud.memorystore_v1beta.types.ZoneDistributionConfig
Optional. Immutable. Zone distribution configuration of the instance for node allocation.
deletion_protection_enabled bool
Optional. If set to true deletion of the instance will fail. This field is a member of oneof_ _deletion_protection_enabled.
psc_auto_connections MutableSequence[google.cloud.memorystore_v1beta.types.PscAutoConnection]
Required. Immutable. User inputs and resource details of the auto-created PSC connections.
endpoints MutableSequence[google.cloud.memorystore_v1beta.types.Instance.InstanceEndpoint]
Optional. Endpoints for the instance.
mode google.cloud.memorystore_v1beta.types.Instance.Mode
Optional. The mode config for the instance.
server_ca_mode google.cloud.memorystore_v1beta.types.Instance.ServerCaMode
Optional. Immutable. The Server CA mode for the instance. This field is a member of oneof_ _server_ca_mode.
server_ca_pool str
Optional. Immutable. The customer-managed CA pool for the instance. Only applicable if the Server CA mode is CUSTOMER_MANAGED_CAS_CA. Format: "projects/{project}/locations/{region}/caPools/{ca_pool}". This field is a member of oneof_ _server_ca_pool.
rotate_server_certificate bool
Optional. Input only. Rotate the server certificates. This field is a member of oneof_ _rotate_server_certificate.

Classes

AuthorizationMode

AuthorizationMode(value)

Possible authorization modes of the instance.

ConnectionDetail

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

Information of each PSC connection.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

EngineConfigsEntry

EngineConfigsEntry(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.

InstanceEndpoint

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

InstanceEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the instance. In each group, there shall be one connection for each service attachment in the cluster.

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.

Mode

Mode(value)

The mode config, which is used to enable/disable cluster mode.

NodeType

NodeType(value)

Possible node types of the instance. See https://cloud.google.com/memorystore/docs/valkey/instance-node-specification for more information.

ServerCaMode

ServerCaMode(value)

The Server CA mode for the instance.

State

State(value)

Possible states of the instance.

StateInfo

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

Additional information about the state of the instance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

TransitEncryptionMode

TransitEncryptionMode(value)

Possible in-transit encryption modes of the instance.