Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. alloydb
  5. getInstance
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.alloydb.getInstance

Explore with Pulumi AI

gcp logo
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

    Use this data source to get information about the available instance. For more details refer the API docs.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const qa = gcp.alloydb.getInstance({});

    import pulumi
import pulumi_gcp as gcp

qa = gcp.alloydb.get_instance()

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/alloydb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := alloydb.LookupInstance(ctx, &alloydb.LookupInstanceArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var qa = Gcp.Alloydb.GetInstance.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.alloydb.AlloydbFunctions;
import com.pulumi.gcp.alloydb.inputs.GetInstanceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var qa = AlloydbFunctions.getInstance();

    }
}

    variables:
  qa:
    fn::invoke:
      function: gcp:alloydb:getInstance
      arguments: {}

    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.

    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,
                 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,
                 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: gcp:alloydb/getInstance:getInstance
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterId string
    The ID of the alloydb cluster that the instance belongs to. 'alloydb_cluster_id'
    InstanceId string
    The ID of the alloydb instance. 'alloydb_instance_id'
    Location string
    (optional) The canonical id of the location.If it is not provided, the provider project is used. For example: us-east1.
    Project string
    (optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ClusterId string
    The ID of the alloydb cluster that the instance belongs to. 'alloydb_cluster_id'
    InstanceId string
    The ID of the alloydb instance. 'alloydb_instance_id'
    Location string
    (optional) The canonical id of the location.If it is not provided, the provider project is used. For example: us-east1.
    Project string
    (optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    clusterId String
    The ID of the alloydb cluster that the instance belongs to. 'alloydb_cluster_id'
    instanceId String
    The ID of the alloydb instance. 'alloydb_instance_id'
    location String
    (optional) The canonical id of the location.If it is not provided, the provider project is used. For example: us-east1.
    project String
    (optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    clusterId string
    The ID of the alloydb cluster that the instance belongs to. 'alloydb_cluster_id'
    instanceId string
    The ID of the alloydb instance. 'alloydb_instance_id'
    location string
    (optional) The canonical id of the location.If it is not provided, the provider project is used. For example: us-east1.
    project string
    (optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    cluster_id str
    The ID of the alloydb cluster that the instance belongs to. 'alloydb_cluster_id'
    instance_id str
    The ID of the alloydb instance. 'alloydb_instance_id'
    location str
    (optional) The canonical id of the location.If it is not provided, the provider project is used. For example: us-east1.
    project str
    (optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    clusterId String
    The ID of the alloydb cluster that the instance belongs to. 'alloydb_cluster_id'
    instanceId String
    The ID of the alloydb instance. 'alloydb_instance_id'
    location String
    (optional) The canonical id of the location.If it is not provided, the provider project is used. For example: us-east1.
    project String
    (optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    getInstance Result

    The following output properties are available:

    Annotations Dictionary<string, string>
    AvailabilityType string
    ClientConnectionConfigs List<GetInstanceClientConnectionConfig>
    Cluster string
    ClusterId string
    CreateTime string
    DatabaseFlags Dictionary<string, string>
    DisplayName string
    EffectiveAnnotations Dictionary<string, string>
    EffectiveLabels Dictionary<string, string>
    GceZone string
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    InstanceType string
    IpAddress string
    Labels Dictionary<string, string>
    MachineConfigs List<GetInstanceMachineConfig>
    Name string
    NetworkConfigs List<GetInstanceNetworkConfig>
    ObservabilityConfigs List<GetInstanceObservabilityConfig>
    OutboundPublicIpAddresses List<string>
    PscInstanceConfigs List<GetInstancePscInstanceConfig>
    PublicIpAddress string
    PulumiLabels Dictionary<string, string>
    QueryInsightsConfigs List<GetInstanceQueryInsightsConfig>
    ReadPoolConfigs List<GetInstanceReadPoolConfig>
    Reconciling bool
    State string
    Uid string
    UpdateTime string
    Location string
    Project string
    Annotations map[string]string
    AvailabilityType string
    ClientConnectionConfigs []GetInstanceClientConnectionConfig
    Cluster string
    ClusterId string
    CreateTime string
    DatabaseFlags map[string]string
    DisplayName string
    EffectiveAnnotations map[string]string
    EffectiveLabels map[string]string
    GceZone string
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    InstanceType string
    IpAddress string
    Labels map[string]string
    MachineConfigs []GetInstanceMachineConfig
    Name string
    NetworkConfigs []GetInstanceNetworkConfig
    ObservabilityConfigs []GetInstanceObservabilityConfig
    OutboundPublicIpAddresses []string
    PscInstanceConfigs []GetInstancePscInstanceConfig
    PublicIpAddress string
    PulumiLabels map[string]string
    QueryInsightsConfigs []GetInstanceQueryInsightsConfig
    ReadPoolConfigs []GetInstanceReadPoolConfig
    Reconciling bool
    State string
    Uid string
    UpdateTime string
    Location string
    Project string
    annotations Map<String,String>
    availabilityType String
    clientConnectionConfigs List<GetInstanceClientConnectionConfig>
    cluster String
    clusterId String
    createTime String
    databaseFlags Map<String,String>
    displayName String
    effectiveAnnotations Map<String,String>
    effectiveLabels Map<String,String>
    gceZone String
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    instanceType String
    ipAddress String
    labels Map<String,String>
    machineConfigs List<GetInstanceMachineConfig>
    name String
    networkConfigs List<GetInstanceNetworkConfig>
    observabilityConfigs List<GetInstanceObservabilityConfig>
    outboundPublicIpAddresses List<String>
    pscInstanceConfigs List<GetInstancePscInstanceConfig>
    publicIpAddress String
    pulumiLabels Map<String,String>
    queryInsightsConfigs List<GetInstanceQueryInsightsConfig>
    readPoolConfigs List<GetInstanceReadPoolConfig>
    reconciling Boolean
    state String
    uid String
    updateTime String
    location String
    project String
    annotations {[key: string]: string}
    availabilityType string
    clientConnectionConfigs GetInstanceClientConnectionConfig[]
    cluster string
    clusterId string
    createTime string
    databaseFlags {[key: string]: string}
    displayName string
    effectiveAnnotations {[key: string]: string}
    effectiveLabels {[key: string]: string}
    gceZone string
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    instanceType string
    ipAddress string
    labels {[key: string]: string}
    machineConfigs GetInstanceMachineConfig[]
    name string
    networkConfigs GetInstanceNetworkConfig[]
    observabilityConfigs GetInstanceObservabilityConfig[]
    outboundPublicIpAddresses string[]
    pscInstanceConfigs GetInstancePscInstanceConfig[]
    publicIpAddress string
    pulumiLabels {[key: string]: string}
    queryInsightsConfigs GetInstanceQueryInsightsConfig[]
    readPoolConfigs GetInstanceReadPoolConfig[]
    reconciling boolean
    state string
    uid string
    updateTime string
    location string
    project string
    annotations Mapping[str, str]
    availability_type str
    client_connection_configs Sequence[GetInstanceClientConnectionConfig]
    cluster str
    cluster_id str
    create_time str
    database_flags Mapping[str, str]
    display_name str
    effective_annotations Mapping[str, str]
    effective_labels Mapping[str, str]
    gce_zone str
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    instance_type str
    ip_address str
    labels Mapping[str, str]
    machine_configs Sequence[GetInstanceMachineConfig]
    name str
    network_configs Sequence[GetInstanceNetworkConfig]
    observability_configs Sequence[GetInstanceObservabilityConfig]
    outbound_public_ip_addresses Sequence[str]
    psc_instance_configs Sequence[GetInstancePscInstanceConfig]
    public_ip_address str
    pulumi_labels Mapping[str, str]
    query_insights_configs Sequence[GetInstanceQueryInsightsConfig]
    read_pool_configs Sequence[GetInstanceReadPoolConfig]
    reconciling bool
    state str
    uid str
    update_time str
    location str
    project str

    Supporting Types

    GetInstanceClientConnectionConfig

    RequireConnectors bool
    Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
    SslConfigs List<GetInstanceClientConnectionConfigSslConfig>
    SSL config option for this instance.
    RequireConnectors bool
    Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
    SslConfigs []GetInstanceClientConnectionConfigSslConfig
    SSL config option for this instance.
    requireConnectors Boolean
    Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
    sslConfigs List<GetInstanceClientConnectionConfigSslConfig>
    SSL config option for this instance.
    requireConnectors boolean
    Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
    sslConfigs GetInstanceClientConnectionConfigSslConfig[]
    SSL config option for this instance.
    require_connectors bool
    Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
    ssl_configs Sequence[GetInstanceClientConnectionConfigSslConfig]
    SSL config option for this instance.
    requireConnectors Boolean
    Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
    sslConfigs List<Property Map>
    SSL config option for this instance.

    GetInstanceClientConnectionConfigSslConfig

    SslMode string
    SSL mode. Specifies client-server SSL/TLS connection behavior. Possible values: ["ENCRYPTED_ONLY", "ALLOW_UNENCRYPTED_AND_ENCRYPTED"]
    SslMode string
    SSL mode. Specifies client-server SSL/TLS connection behavior. Possible values: ["ENCRYPTED_ONLY", "ALLOW_UNENCRYPTED_AND_ENCRYPTED"]
    sslMode String
    SSL mode. Specifies client-server SSL/TLS connection behavior. Possible values: ["ENCRYPTED_ONLY", "ALLOW_UNENCRYPTED_AND_ENCRYPTED"]
    sslMode string
    SSL mode. Specifies client-server SSL/TLS connection behavior. Possible values: ["ENCRYPTED_ONLY", "ALLOW_UNENCRYPTED_AND_ENCRYPTED"]
    ssl_mode str
    SSL mode. Specifies client-server SSL/TLS connection behavior. Possible values: ["ENCRYPTED_ONLY", "ALLOW_UNENCRYPTED_AND_ENCRYPTED"]
    sslMode String
    SSL mode. Specifies client-server SSL/TLS connection behavior. Possible values: ["ENCRYPTED_ONLY", "ALLOW_UNENCRYPTED_AND_ENCRYPTED"]

    GetInstanceMachineConfig

    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.

    GetInstanceNetworkConfig

    AuthorizedExternalNetworks List<GetInstanceNetworkConfigAuthorizedExternalNetwork>
    A list of external networks authorized to access this instance. This field is only allowed to be set when 'enable_public_ip' is set to true.
    EnableOutboundPublicIp bool
    Enabling outbound public ip for the instance.
    EnablePublicIp bool
    Enabling public ip for the instance. If a user wishes to disable this, please also clear the list of the authorized external networks set on the same instance.
    AuthorizedExternalNetworks []GetInstanceNetworkConfigAuthorizedExternalNetwork
    A list of external networks authorized to access this instance. This field is only allowed to be set when 'enable_public_ip' is set to true.
    EnableOutboundPublicIp bool
    Enabling outbound public ip for the instance.
    EnablePublicIp bool
    Enabling public ip for the instance. If a user wishes to disable this, please also clear the list of the authorized external networks set on the same instance.
    authorizedExternalNetworks List<GetInstanceNetworkConfigAuthorizedExternalNetwork>
    A list of external networks authorized to access this instance. This field is only allowed to be set when 'enable_public_ip' is set to true.
    enableOutboundPublicIp Boolean
    Enabling outbound public ip for the instance.
    enablePublicIp Boolean
    Enabling public ip for the instance. If a user wishes to disable this, please also clear the list of the authorized external networks set on the same instance.
    authorizedExternalNetworks GetInstanceNetworkConfigAuthorizedExternalNetwork[]
    A list of external networks authorized to access this instance. This field is only allowed to be set when 'enable_public_ip' is set to true.
    enableOutboundPublicIp boolean
    Enabling outbound public ip for the instance.
    enablePublicIp boolean
    Enabling public ip for the instance. If a user wishes to disable this, please also clear the list of the authorized external networks set on the same instance.
    authorized_external_networks Sequence[GetInstanceNetworkConfigAuthorizedExternalNetwork]
    A list of external networks authorized to access this instance. This field is only allowed to be set when 'enable_public_ip' is set to true.
    enable_outbound_public_ip bool
    Enabling outbound public ip for the instance.
    enable_public_ip bool
    Enabling public ip for the instance. If a user wishes to disable this, please also clear the list of the authorized external networks set on the same instance.
    authorizedExternalNetworks List<Property Map>
    A list of external networks authorized to access this instance. This field is only allowed to be set when 'enable_public_ip' is set to true.
    enableOutboundPublicIp Boolean
    Enabling outbound public ip for the instance.
    enablePublicIp Boolean
    Enabling public ip for the instance. If a user wishes to disable this, please also clear the list of the authorized external networks set on the same instance.

    GetInstanceNetworkConfigAuthorizedExternalNetwork

    CidrRange string
    CIDR range for one authorized network of the instance.
    CidrRange string
    CIDR range for one authorized network of the instance.
    cidrRange String
    CIDR range for one authorized network of the instance.
    cidrRange string
    CIDR range for one authorized network of the instance.
    cidr_range str
    CIDR range for one authorized network of the instance.
    cidrRange String
    CIDR range for one authorized network of the instance.

    GetInstanceObservabilityConfig

    Enabled bool
    Observability feature status for an instance.
    MaxQueryStringLength int
    Query string length. The default value is 10240. Any integer between 1024 and 100000 is considered valid.
    PreserveComments bool
    Preserve comments in the query string.
    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 200 is considered valid.
    RecordApplicationTags bool
    Record application tags for an instance. This flag is turned "on" by default.
    TrackActiveQueries bool
    Track actively running queries. If not set, default value is "off".
    TrackWaitEventTypes bool
    Record wait event types during query execution for an instance.
    TrackWaitEvents bool
    Record wait events during query execution for an instance.
    Enabled bool
    Observability feature status for an instance.
    MaxQueryStringLength int
    Query string length. The default value is 10240. Any integer between 1024 and 100000 is considered valid.
    PreserveComments bool
    Preserve comments in the query string.
    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 200 is considered valid.
    RecordApplicationTags bool
    Record application tags for an instance. This flag is turned "on" by default.
    TrackActiveQueries bool
    Track actively running queries. If not set, default value is "off".
    TrackWaitEventTypes bool
    Record wait event types during query execution for an instance.
    TrackWaitEvents bool
    Record wait events during query execution for an instance.
    enabled Boolean
    Observability feature status for an instance.
    maxQueryStringLength Integer
    Query string length. The default value is 10240. Any integer between 1024 and 100000 is considered valid.
    preserveComments Boolean
    Preserve comments in the query string.
    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 200 is considered valid.
    recordApplicationTags Boolean
    Record application tags for an instance. This flag is turned "on" by default.
    trackActiveQueries Boolean
    Track actively running queries. If not set, default value is "off".
    trackWaitEventTypes Boolean
    Record wait event types during query execution for an instance.
    trackWaitEvents Boolean
    Record wait events during query execution for an instance.
    enabled boolean
    Observability feature status for an instance.
    maxQueryStringLength number
    Query string length. The default value is 10240. Any integer between 1024 and 100000 is considered valid.
    preserveComments boolean
    Preserve comments in the query string.
    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 200 is considered valid.
    recordApplicationTags boolean
    Record application tags for an instance. This flag is turned "on" by default.
    trackActiveQueries boolean
    Track actively running queries. If not set, default value is "off".
    trackWaitEventTypes boolean
    Record wait event types during query execution for an instance.
    trackWaitEvents boolean
    Record wait events during query execution for an instance.
    enabled bool
    Observability feature status for an instance.
    max_query_string_length int
    Query string length. The default value is 10240. Any integer between 1024 and 100000 is considered valid.
    preserve_comments bool
    Preserve comments in the query string.
    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 200 is considered valid.
    record_application_tags bool
    Record application tags for an instance. This flag is turned "on" by default.
    track_active_queries bool
    Track actively running queries. If not set, default value is "off".
    track_wait_event_types bool
    Record wait event types during query execution for an instance.
    track_wait_events bool
    Record wait events during query execution for an instance.
    enabled Boolean
    Observability feature status for an instance.
    maxQueryStringLength Number
    Query string length. The default value is 10240. Any integer between 1024 and 100000 is considered valid.
    preserveComments Boolean
    Preserve comments in the query string.
    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 200 is considered valid.
    recordApplicationTags Boolean
    Record application tags for an instance. This flag is turned "on" by default.
    trackActiveQueries Boolean
    Track actively running queries. If not set, default value is "off".
    trackWaitEventTypes Boolean
    Record wait event types during query execution for an instance.
    trackWaitEvents Boolean
    Record wait events during query execution for an instance.

    GetInstancePscInstanceConfig

    AllowedConsumerProjects List<string>
    List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance. These should be specified as project numbers only.
    PscDnsName string
    The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog
    PscInterfaceConfigs List<GetInstancePscInstanceConfigPscInterfaceConfig>
    Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Currently, AlloyDB supports only 0 or 1 PSC interface.
    ServiceAttachmentLink string
    The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of 'projects//regions//serviceAttachments/'
    AllowedConsumerProjects []string
    List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance. These should be specified as project numbers only.
    PscDnsName string
    The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog
    PscInterfaceConfigs []GetInstancePscInstanceConfigPscInterfaceConfig
    Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Currently, AlloyDB supports only 0 or 1 PSC interface.
    ServiceAttachmentLink string
    The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of 'projects//regions//serviceAttachments/'
    allowedConsumerProjects List<String>
    List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance. These should be specified as project numbers only.
    pscDnsName String
    The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog
    pscInterfaceConfigs List<GetInstancePscInstanceConfigPscInterfaceConfig>
    Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Currently, AlloyDB supports only 0 or 1 PSC interface.
    serviceAttachmentLink String
    The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of 'projects//regions//serviceAttachments/'
    allowedConsumerProjects string[]
    List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance. These should be specified as project numbers only.
    pscDnsName string
    The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog
    pscInterfaceConfigs GetInstancePscInstanceConfigPscInterfaceConfig[]
    Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Currently, AlloyDB supports only 0 or 1 PSC interface.
    serviceAttachmentLink string
    The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of 'projects//regions//serviceAttachments/'
    allowed_consumer_projects Sequence[str]
    List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance. These should be specified as project numbers only.
    psc_dns_name str
    The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog
    psc_interface_configs Sequence[GetInstancePscInstanceConfigPscInterfaceConfig]
    Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Currently, AlloyDB supports only 0 or 1 PSC interface.
    service_attachment_link str
    The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of 'projects//regions//serviceAttachments/'
    allowedConsumerProjects List<String>
    List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance. These should be specified as project numbers only.
    pscDnsName String
    The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog
    pscInterfaceConfigs List<Property Map>
    Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Currently, AlloyDB supports only 0 or 1 PSC interface.
    serviceAttachmentLink String
    The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of 'projects//regions//serviceAttachments/'

    GetInstancePscInstanceConfigPscInterfaceConfig

    NetworkAttachmentResource string
    The network attachment resource created in the consumer project to which the PSC interface will be linked. This is of the format: "projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}". The network attachment must be in the same region as the instance.
    NetworkAttachmentResource string
    The network attachment resource created in the consumer project to which the PSC interface will be linked. This is of the format: "projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}". The network attachment must be in the same region as the instance.
    networkAttachmentResource String
    The network attachment resource created in the consumer project to which the PSC interface will be linked. This is of the format: "projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}". The network attachment must be in the same region as the instance.
    networkAttachmentResource string
    The network attachment resource created in the consumer project to which the PSC interface will be linked. This is of the format: "projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}". The network attachment must be in the same region as the instance.
    network_attachment_resource str
    The network attachment resource created in the consumer project to which the PSC interface will be linked. This is of the format: "projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}". The network attachment must be in the same region as the instance.
    networkAttachmentResource String
    The network attachment resource created in the consumer project to which the PSC interface will be linked. This is of the format: "projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}". The network attachment must be in the same region as the instance.

    GetInstanceQueryInsightsConfig

    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.

    GetInstanceReadPoolConfig

    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.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
    pulumi/pulumi-gcp