Instance

import type { Instance } from "https://googleapis.deno.dev/v1/alloydb:v1.ts";

An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.

interface Instance {

activationPolicy?: "ACTIVATION_POLICY_UNSPECIFIED" | "ALWAYS" | "NEVER";

annotations?: {

[key: string]: string;

};

availabilityType?: "AVAILABILITY_TYPE_UNSPECIFIED" | "ZONAL" | "REGIONAL";

clientConnectionConfig?: ClientConnectionConfig;

readonly createTime?: Date;

databaseFlags?: {

[key: string]: string;

};

readonly deleteTime?: Date;

displayName?: string;

etag?: string;

gceZone?: string;

instanceType?:

| "INSTANCE_TYPE_UNSPECIFIED"

| "PRIMARY"

| "READ_POOL"

| "SECONDARY";

readonly ipAddress?: string;

labels?: {

[key: string]: string;

};

machineConfig?: MachineConfig;

readonly name?: string;

networkConfig?: InstanceNetworkConfig;

readonly nodes?: Node[];

observabilityConfig?: ObservabilityInstanceConfig;

readonly outboundPublicIpAddresses?: string[];

pscInstanceConfig?: PscInstanceConfig;

readonly publicIpAddress?: string;

queryInsightsConfig?: QueryInsightsInstanceConfig;

readPoolConfig?: ReadPoolConfig;

readonly reconciling?: boolean;

readonly satisfiesPzs?: boolean;

readonly state?:

| "STATE_UNSPECIFIED"

| "READY"

| "STOPPED"

| "CREATING"

| "DELETING"

| "MAINTENANCE"

| "FAILED"

| "BOOTSTRAPPING"

| "PROMOTING";

readonly uid?: string;

readonly updateTime?: Date;

readonly writableNode?: Node;

}

§Properties

activationPolicy?: "ACTIVATION_POLICY_UNSPECIFIED" | "ALWAYS" | "NEVER"

[src]

Optional. Specifies whether an instance needs to spin up. Once the instance is active, the activation policy can be updated to the NEVER to stop the instance. Likewise, the activation policy can be updated to ALWAYS to start the instance. There are restrictions around when an instance can/cannot be activated (for example, a read pool instance should be stopped before stopping primary etc.). Please refer to the API documentation for more details.

annotations?: {

[key: string]: string;

}

[src]

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

availabilityType?: "AVAILABILITY_TYPE_UNSPECIFIED" | "ZONAL" | "REGIONAL"

[src]

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).

clientConnectionConfig?: ClientConnectionConfig

[src]

Optional. Client connection specific configurations

readonly createTime?: Date

[src]

Output only. Create time stamp

databaseFlags?: {

[key: string]: string;

}

[src]

Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. 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.

readonly deleteTime?: Date

[src]

Output only. Delete time stamp

displayName?: string

[src]

User-settable and human-readable display name for the Instance.

etag?: string

[src]

For Resource freshness validation (https://google.aip.dev/154)

gceZone?: string

[src]

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.

instanceType?: "INSTANCE_TYPE_UNSPECIFIED" | "PRIMARY" | "READ_POOL" | "SECONDARY"

[src]

Required. The type of the instance. Specified at creation time.

readonly ipAddress?: string

[src]

Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.

labels?: {

[key: string]: string;

}

[src]

Labels as key value pairs

machineConfig?: MachineConfig

[src]

Configurations for the machines that host the underlying database engine.

readonly name?: string

[src]

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}

networkConfig?: InstanceNetworkConfig

[src]

Optional. Instance-level network configuration.

readonly nodes?: Node[]

[src]

Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.

observabilityConfig?: ObservabilityInstanceConfig

[src]

Configuration for observability.

readonly outboundPublicIpAddresses?: string[]

[src]

Output only. All outbound public IP addresses configured for the instance.

pscInstanceConfig?: PscInstanceConfig

[src]

Optional. The configuration for Private Service Connect (PSC) for the instance.

readonly publicIpAddress?: string

[src]

Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.

queryInsightsConfig?: QueryInsightsInstanceConfig

[src]

Configuration for query insights.

readPoolConfig?: ReadPoolConfig

[src]

Read pool instance configuration. This is required if the value of instanceType is READ_POOL.

readonly reconciling?: boolean

[src]

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.

readonly satisfiesPzs?: boolean

[src]

Output only. Reserved for future use.

[src]

Output only. The current serving state of the instance.

readonly uid?: string

[src]

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.

readonly updateTime?: Date

[src]

Output only. Update time stamp

readonly writableNode?: Node

[src]

Output only. This is set for the read-write VM of the PRIMARY instance only.