Google Cloud Native v0.32.0, Nov 29 23

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.alloydb/v1.getInstance

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Using getInstance

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>

def get_instance(cluster_id: Optional[str] = None,
                 instance_id: Optional[str] = None,
                 location: Optional[str] = None,
                 project: Optional[str] = None,
                 view: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(cluster_id: Optional[pulumi.Input[str]] = None,
                 instance_id: Optional[pulumi.Input[str]] = None,
                 location: Optional[pulumi.Input[str]] = None,
                 project: Optional[pulumi.Input[str]] = None,
                 view: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]

func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput

> Note: This function is named LookupInstance in the Go SDK.

public static class GetInstance 
{
    public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
public static Output<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)

fn::invoke:
  function: google-native:alloydb/v1:getInstance
  arguments:
    # arguments dictionary

The following arguments are supported:

ClusterId string
InstanceId string
Location string
Project string
View string

ClusterId string
InstanceId string
Location string
Project string
View string

clusterId String
instanceId String
location String
project String
view String

clusterId string
instanceId string
location string
project string
view string

cluster_id str
instance_id str
location str
project str
view str

clusterId String
instanceId String
location String
project String
view String

getInstance Result

The following output properties are available:

Annotations Dictionary<string, string>: Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
AvailabilityType string: 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 Pulumi.GoogleNative.AlloyDB.V1.Outputs.ClientConnectionConfigResponse: Optional. Client connection specific configurations
CreateTime string: Create time stamp
DatabaseFlags Dictionary<string, string>: 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.
DeleteTime string: Delete time stamp
DisplayName string: User-settable and human-readable display name for the Instance.
Etag string: For Resource freshness validation (https://google.aip.dev/154)
GceZone string: 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 string: The type of the instance. Specified at creation time.
IpAddress string: The IP address for the Instance. This is the connection endpoint for an end-user application.
Labels Dictionary<string, string>: Labels as key value pairs
MachineConfig Pulumi.GoogleNative.AlloyDB.V1.Outputs.MachineConfigResponse: Configurations for the machines that host the underlying database engine.
Name string: 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}
Nodes List<Pulumi.GoogleNative.AlloyDB.V1.Outputs.NodeResponse>: List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
QueryInsightsConfig Pulumi.GoogleNative.AlloyDB.V1.Outputs.QueryInsightsInstanceConfigResponse: Configuration for query insights.
ReadPoolConfig Pulumi.GoogleNative.AlloyDB.V1.Outputs.ReadPoolConfigResponse: Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
Reconciling bool: 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.
State string: The current serving state of the instance.
Uid string: The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
UpdateTime string: Update time stamp
WritableNode Pulumi.GoogleNative.AlloyDB.V1.Outputs.NodeResponse: This is set for the read-write VM of the PRIMARY instance only.

Annotations map[string]string: Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
AvailabilityType string: 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 ClientConnectionConfigResponse: Optional. Client connection specific configurations
CreateTime string: Create time stamp
DatabaseFlags map[string]string: 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.
DeleteTime string: Delete time stamp
DisplayName string: User-settable and human-readable display name for the Instance.
Etag string: For Resource freshness validation (https://google.aip.dev/154)
GceZone string: 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 string: The type of the instance. Specified at creation time.
IpAddress string: The IP address for the Instance. This is the connection endpoint for an end-user application.
Labels map[string]string: Labels as key value pairs
MachineConfig MachineConfigResponse: Configurations for the machines that host the underlying database engine.
Name string: 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}
Nodes []NodeResponse: List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
QueryInsightsConfig QueryInsightsInstanceConfigResponse: Configuration for query insights.
ReadPoolConfig ReadPoolConfigResponse: Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
Reconciling bool: 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.
State string: The current serving state of the instance.
Uid string: The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
UpdateTime string: Update time stamp
WritableNode NodeResponse: This is set for the read-write VM of the PRIMARY instance only.

annotations Map<String,String>: Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
availabilityType String: 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 ClientConnectionConfigResponse: Optional. Client connection specific configurations
createTime String: Create time stamp
databaseFlags Map<String,String>: 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.
deleteTime String: Delete time stamp
displayName String: User-settable and human-readable display name for the Instance.
etag String: For Resource freshness validation (https://google.aip.dev/154)
gceZone String: 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 String: The type of the instance. Specified at creation time.
ipAddress String: The IP address for the Instance. This is the connection endpoint for an end-user application.
labels Map<String,String>: Labels as key value pairs
machineConfig MachineConfigResponse: Configurations for the machines that host the underlying database engine.
name String: 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}
nodes List<NodeResponse>: List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
queryInsightsConfig QueryInsightsInstanceConfigResponse: Configuration for query insights.
readPoolConfig ReadPoolConfigResponse: Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
reconciling Boolean: 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.
state String: The current serving state of the instance.
uid String: The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
updateTime String: Update time stamp
writableNode NodeResponse: This is set for the read-write VM of the PRIMARY instance only.

annotations {[key: string]: string}: Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
availabilityType string: 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 ClientConnectionConfigResponse: Optional. Client connection specific configurations
createTime string: Create time stamp
databaseFlags {[key: string]: string}: 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.
deleteTime string: Delete time stamp
displayName string: User-settable and human-readable display name for the Instance.
etag string: For Resource freshness validation (https://google.aip.dev/154)
gceZone string: 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 string: The type of the instance. Specified at creation time.
ipAddress string: The IP address for the Instance. This is the connection endpoint for an end-user application.
labels {[key: string]: string}: Labels as key value pairs
machineConfig MachineConfigResponse: Configurations for the machines that host the underlying database engine.
name string: 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}
nodes NodeResponse[]: List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
queryInsightsConfig QueryInsightsInstanceConfigResponse: Configuration for query insights.
readPoolConfig ReadPoolConfigResponse: Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
reconciling boolean: 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.
state string: The current serving state of the instance.
uid string: The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
updateTime string: Update time stamp
writableNode NodeResponse: This is set for the read-write VM of the PRIMARY instance only.

annotations Mapping[str, str]: Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
availability_type str: 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).
client_connection_config ClientConnectionConfigResponse: Optional. Client connection specific configurations
create_time str: Create time stamp
database_flags Mapping[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.
delete_time str: Delete time stamp
display_name str: User-settable and human-readable display name for the Instance.
etag str: For Resource freshness validation (https://google.aip.dev/154)
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.
instance_type str: The type of the instance. Specified at creation time.
ip_address str: The IP address for the Instance. This is the connection endpoint for an end-user application.
labels Mapping[str, str]: Labels as key value pairs
machine_config MachineConfigResponse: Configurations for the machines that host the underlying database engine.
name str: 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}
nodes Sequence[NodeResponse]: List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
query_insights_config QueryInsightsInstanceConfigResponse: Configuration for query insights.
read_pool_config ReadPoolConfigResponse: Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
reconciling bool: 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.
state str: The current serving state of the instance.
uid str: The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
update_time str: Update time stamp
writable_node NodeResponse: This is set for the read-write VM of the PRIMARY instance only.

annotations Map<String>: Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
availabilityType String: 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 Property Map: Optional. Client connection specific configurations
createTime String: Create time stamp
databaseFlags Map<String>: 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.
deleteTime String: Delete time stamp
displayName String: User-settable and human-readable display name for the Instance.
etag String: For Resource freshness validation (https://google.aip.dev/154)
gceZone String: 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 String: The type of the instance. Specified at creation time.
ipAddress String: The IP address for the Instance. This is the connection endpoint for an end-user application.
labels Map<String>: Labels as key value pairs
machineConfig Property Map: Configurations for the machines that host the underlying database engine.
name String: 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}
nodes List<Property Map>: List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
queryInsightsConfig Property Map: Configuration for query insights.
readPoolConfig Property Map: Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
reconciling Boolean: 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.
state String: The current serving state of the instance.
uid String: The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
updateTime String: Update time stamp
writableNode Property Map: This is set for the read-write VM of the PRIMARY instance only.

Supporting Types

ClientConnectionConfigResponse

RequireConnectors bool: Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
SslConfig Pulumi.GoogleNative.AlloyDB.V1.Inputs.SslConfigResponse: Optional. SSL config option for this instance.

RequireConnectors bool: Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
SslConfig SslConfigResponse: Optional. SSL config option for this instance.

requireConnectors Boolean: Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
sslConfig SslConfigResponse: Optional. SSL config option for this instance.

requireConnectors boolean: Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
sslConfig SslConfigResponse: Optional. SSL config option for this instance.

require_connectors bool: Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
ssl_config SslConfigResponse: Optional. SSL config option for this instance.

requireConnectors Boolean: Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
sslConfig Property Map: Optional. SSL config option for this instance.

MachineConfigResponse

CpuCount int: The number of CPU's in the VM instance.

CpuCount int: The number of CPU's in the VM instance.

cpuCount Integer: The number of CPU's in the VM instance.

cpuCount number: The number of CPU's in the VM instance.

cpu_count int: The number of CPU's in the VM instance.

cpuCount Number: The number of CPU's in the VM instance.

NodeResponse

Ip string: The private IP address of the VM e.g. "10.57.0.34".
State string: Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
Zone string: The Compute Engine zone of the VM e.g. "us-central1-b".

Ip string: The private IP address of the VM e.g. "10.57.0.34".
State string: Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
Zone string: The Compute Engine zone of the VM e.g. "us-central1-b".

ip String: The private IP address of the VM e.g. "10.57.0.34".
state String: Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
zone String: The Compute Engine zone of the VM e.g. "us-central1-b".

ip string: The private IP address of the VM e.g. "10.57.0.34".
state string: Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
zone string: The Compute Engine zone of the VM e.g. "us-central1-b".

ip str: The private IP address of the VM e.g. "10.57.0.34".
state str: Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
zone str: The Compute Engine zone of the VM e.g. "us-central1-b".

ip String: The private IP address of the VM e.g. "10.57.0.34".
state String: Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
zone String: The Compute Engine zone of the VM e.g. "us-central1-b".

QueryInsightsInstanceConfigResponse

QueryPlansPerMinute int: Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
QueryStringLength int: Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
RecordApplicationTags bool: Record application tags for an instance. This flag is turned "on" by default.
RecordClientAddress bool: Record client address for an instance. Client address is PII information. This flag is turned "on" by default.

QueryPlansPerMinute int: Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
QueryStringLength int: Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
RecordApplicationTags bool: Record application tags for an instance. This flag is turned "on" by default.
RecordClientAddress bool: Record client address for an instance. Client address is PII information. This flag is turned "on" by default.

queryPlansPerMinute Integer: Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
queryStringLength Integer: Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
recordApplicationTags Boolean: Record application tags for an instance. This flag is turned "on" by default.
recordClientAddress Boolean: Record client address for an instance. Client address is PII information. This flag is turned "on" by default.

queryPlansPerMinute number: Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
queryStringLength number: Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
recordApplicationTags boolean: Record application tags for an instance. This flag is turned "on" by default.
recordClientAddress boolean: Record client address for an instance. Client address is PII information. This flag is turned "on" by default.

query_plans_per_minute int: Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
query_string_length int: Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
record_application_tags bool: Record application tags for an instance. This flag is turned "on" by default.
record_client_address bool: Record client address for an instance. Client address is PII information. This flag is turned "on" by default.

queryPlansPerMinute Number: Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
queryStringLength Number: Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
recordApplicationTags Boolean: Record application tags for an instance. This flag is turned "on" by default.
recordClientAddress Boolean: Record client address for an instance. Client address is PII information. This flag is turned "on" by default.

ReadPoolConfigResponse

NodeCount int: Read capacity, i.e. number of nodes in a read pool instance.

NodeCount int: Read capacity, i.e. number of nodes in a read pool instance.

nodeCount Integer: Read capacity, i.e. number of nodes in a read pool instance.

nodeCount number: Read capacity, i.e. number of nodes in a read pool instance.

node_count int: Read capacity, i.e. number of nodes in a read pool instance.

nodeCount Number: Read capacity, i.e. number of nodes in a read pool instance.

SslConfigResponse

CaSource string: Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
SslMode string: Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.

CaSource string: Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
SslMode string: Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.

caSource String: Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
sslMode String: Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.

caSource string: Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
sslMode string: Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.

ca_source str: Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
ssl_mode str: Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.

caSource String: Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
sslMode String: Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.alloydb/v1.getInstance

On this page

On this page

Using getInstance

getInstance Result

Supporting Types

ClientConnectionConfigResponse

MachineConfigResponse

NodeResponse

QueryInsightsInstanceConfigResponse

ReadPoolConfigResponse

SslConfigResponse

Package Details

On this page

On this page