Instance(mapping=None, *, ignore_unknown_fields=False, **kwargs)An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.
Attributes | |
|---|---|
| Name | Description |
name |
str
Output only. The name of the instance resource with the format: - projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?,
e.g. 1-63 characters of lowercase letters, numbers, and
dashes, starting with a letter, and ending with a letter
or number. For more details see
https://google.aip.dev/122. The prefix of the instance
resource name is the name of the parent resource:
- projects/{project}/locations/{region}/clusters/{cluster_id}
|
display_name |
str
User-settable and human-readable display name for the Instance. |
uid |
str
Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted. |
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Create time stamp |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Update time stamp |
delete_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Delete time stamp |
labels |
MutableMapping[str, str]
Labels as key value pairs |
state |
google.cloud.alloydb_v1.types.Instance.State
Output only. The current serving state of the instance. |
instance_type |
google.cloud.alloydb_v1.types.Instance.InstanceType
Required. The type of the instance. Specified at creation time. |
machine_config |
google.cloud.alloydb_v1.types.Instance.MachineConfig
Configurations for the machines that host the underlying database engine. |
availability_type |
google.cloud.alloydb_v1.types.Instance.AvailabilityType
Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones). |
gce_zone |
str
The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity. |
database_flags |
MutableMapping[str, str]
Database flags. Set at instance level. - They are copied from primary instance on read instance creation. - Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. |
writable_node |
google.cloud.alloydb_v1.types.Instance.Node
Output only. This is set for the read-write VM of the PRIMARY instance only. |
nodes |
MutableSequence[google.cloud.alloydb_v1.types.Instance.Node]
Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance. |
query_insights_config |
google.cloud.alloydb_v1.types.Instance.QueryInsightsInstanceConfig
Configuration for query insights. |
read_pool_config |
google.cloud.alloydb_v1.types.Instance.ReadPoolConfig
Read pool instance configuration. This is required if the value of instanceType is READ_POOL. |
ip_address |
str
Output only. The IP address for the Instance. This is the connection endpoint for an end-user application. |
reconciling |
bool
Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. |
etag |
str
For Resource freshness validation (https://google.aip.dev/154) |
annotations |
MutableMapping[str, str]
Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 |
client_connection_config |
google.cloud.alloydb_v1.types.Instance.ClientConnectionConfig
Optional. Client connection specific configurations |
Classes
AnnotationsEntry
AnnotationsEntry(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,
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 |
AvailabilityType
AvailabilityType(value)The Availability type of an instance. Potential values:
- ZONAL: The instance serves data from only one zone. Outages in that zone affect instance availability.
- REGIONAL: The instance can serve data from more than one zone in a region (it is highly available).
Values: AVAILABILITY_TYPE_UNSPECIFIED (0): This is an unknown Availability type. ZONAL (1): Zonal available instance. REGIONAL (2): Regional (or Highly) available instance.
ClientConnectionConfig
ClientConnectionConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)Client connection configuration
DatabaseFlagsEntry
DatabaseFlagsEntry(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,
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 |
InstanceType
InstanceType(value)Type of an Instance
Values: INSTANCE_TYPE_UNSPECIFIED (0): The type of the instance is unknown. PRIMARY (1): PRIMARY instances support read and write operations. READ_POOL (2): READ POOL instances support read operations only. Each read pool instance consists of one or more homogeneous nodes.
- Read pool of size 1 can only have zonal availability.
- Read pools with node count of 2 or more can have regional
availability (nodes are present in 2 or more zones in a
region).
SECONDARY (3):
SECONDARY instances support read operations
only. SECONDARY instance is a cross-region read
replica
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,
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 |
MachineConfig
MachineConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)MachineConfig describes the configuration of a machine.
Node
Node(mapping=None, *, ignore_unknown_fields=False, **kwargs)Details of a single node in the instance. Nodes in an AlloyDB instance are ephemereal, they can change during update, failover, autohealing and resize operations.
QueryInsightsInstanceConfig
QueryInsightsInstanceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)QueryInsights Instance specific configuration.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ReadPoolConfig
ReadPoolConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)Configuration for a read pool instance.
State
State(value)Instance State
Values: STATE_UNSPECIFIED (0): The state of the instance is unknown. READY (1): The instance is active and running. STOPPED (2): The instance is stopped. Instance name and IP resources are preserved. CREATING (3): The instance is being created. DELETING (4): The instance is being deleted. MAINTENANCE (5): The instance is down for maintenance. FAILED (6): The creation of the instance failed or a fatal error occurred during an operation on the instance. Note: Instances in this state would tried to be auto-repaired. And Customers should be able to restart, update or delete these instances. BOOTSTRAPPING (8): Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that index unused in case that state also needs to exposed via consumer apis in future. The instance has been configured to sync data from some other source. PROMOTING (9): The instance is being promoted.