@pulumi/gcp/alloydb/getInstance.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Use this data source to get information about the available instance. For more details refer the [API docs](https://cloud.google.com/alloydb/docs/reference/rest/v1/projects.locations.clusters.instances).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const qa = gcp.alloydb.getInstance({});
 * ```
 */
export declare function getInstance(args: GetInstanceArgs, opts?: pulumi.InvokeOptions): Promise<GetInstanceResult>;
/**
 * A collection of arguments for invoking getInstance.
 */
export interface GetInstanceArgs {
    /**
     * The ID of the alloydb cluster that the instance belongs to.
     * 'alloydb_cluster_id'
     */
    clusterId: string;
    /**
     * The ID of the alloydb instance.
     * 'alloydb_instance_id'
     */
    instanceId: string;
    /**
     * (optional)
     * The canonical id of the location.If it is not provided, the provider project is used. For example: us-east1.
     */
    location?: string;
    /**
     * (optional)
     * The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
     */
    project?: string;
}
/**
 * A collection of values returned by getInstance.
 */
export interface GetInstanceResult {
    readonly annotations: {
        [key: string]: string;
    };
    readonly availabilityType: string;
    readonly clientConnectionConfigs: outputs.alloydb.GetInstanceClientConnectionConfig[];
    readonly cluster: string;
    readonly clusterId: string;
    readonly createTime: string;
    readonly databaseFlags: {
        [key: string]: string;
    };
    readonly displayName: string;
    readonly effectiveAnnotations: {
        [key: string]: string;
    };
    readonly effectiveLabels: {
        [key: string]: string;
    };
    readonly gceZone: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly instanceId: string;
    readonly instanceType: string;
    readonly ipAddress: string;
    readonly labels: {
        [key: string]: string;
    };
    readonly location?: string;
    readonly machineConfigs: outputs.alloydb.GetInstanceMachineConfig[];
    readonly name: string;
    readonly networkConfigs: outputs.alloydb.GetInstanceNetworkConfig[];
    readonly observabilityConfigs: outputs.alloydb.GetInstanceObservabilityConfig[];
    readonly outboundPublicIpAddresses: string[];
    readonly project?: string;
    readonly pscInstanceConfigs: outputs.alloydb.GetInstancePscInstanceConfig[];
    readonly publicIpAddress: string;
    readonly pulumiLabels: {
        [key: string]: string;
    };
    readonly queryInsightsConfigs: outputs.alloydb.GetInstanceQueryInsightsConfig[];
    readonly readPoolConfigs: outputs.alloydb.GetInstanceReadPoolConfig[];
    readonly reconciling: boolean;
    readonly state: string;
    readonly uid: string;
    readonly updateTime: string;
}
/**
 * Use this data source to get information about the available instance. For more details refer the [API docs](https://cloud.google.com/alloydb/docs/reference/rest/v1/projects.locations.clusters.instances).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const qa = gcp.alloydb.getInstance({});
 * ```
 */
export declare function getInstanceOutput(args: GetInstanceOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetInstanceResult>;
/**
 * A collection of arguments for invoking getInstance.
 */
export interface GetInstanceOutputArgs {
    /**
     * The ID of the alloydb cluster that the instance belongs to.
     * 'alloydb_cluster_id'
     */
    clusterId: pulumi.Input<string>;
    /**
     * The ID of the alloydb instance.
     * 'alloydb_instance_id'
     */
    instanceId: pulumi.Input<string>;
    /**
     * (optional)
     * The canonical id of the location.If it is not provided, the provider project is used. For example: us-east1.
     */
    location?: pulumi.Input<string>;
    /**
     * (optional)
     * The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
}