import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../../types/output"; /** * Retrieves a resource containing information about a Cloud SQL instance. */ export declare function getInstance(args: GetInstanceArgs, opts?: pulumi.InvokeOptions): Promise; export interface GetInstanceArgs { instance: string; project?: string; } export interface GetInstanceResult { /** * List all maintenance versions applicable on the instance */ readonly availableMaintenanceVersions: string[]; /** * The backend type. `SECOND_GEN`: Cloud SQL database instance. `EXTERNAL`: A database server that is not managed by Google. This property is read-only; use the `tier` property in the `settings` object to determine the database type. */ readonly backendType: string; /** * Connection name of the Cloud SQL instance used in connection strings. */ readonly connectionName: string; /** * The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. */ readonly createTime: string; /** * The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. */ readonly currentDiskSize: string; /** * Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`. */ readonly databaseInstalledVersion: string; /** * The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. */ readonly databaseVersion: string; /** * Disk encryption configuration specific to an instance. */ readonly diskEncryptionConfiguration: outputs.sqladmin.v1beta4.DiskEncryptionConfigurationResponse; /** * Disk encryption status specific to an instance. */ readonly diskEncryptionStatus: outputs.sqladmin.v1beta4.DiskEncryptionStatusResponse; /** * The dns name of the instance. */ readonly dnsName: string; /** * This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. * * @deprecated This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. */ readonly etag: string; /** * The name and status of the failover replica. */ readonly failoverReplica: outputs.sqladmin.v1beta4.InstanceFailoverReplicaResponse; /** * The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. */ readonly gceZone: string; /** * The instance type. */ readonly instanceType: string; /** * The assigned IP addresses for the instance. */ readonly ipAddresses: outputs.sqladmin.v1beta4.IpMappingResponse[]; /** * The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. * * @deprecated The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. */ readonly ipv6Address: string; /** * This is always `sql#instance`. */ readonly kind: string; /** * The current software version on the instance. */ readonly maintenanceVersion: string; /** * The name of the instance which will act as primary in the replication setup. */ readonly masterInstanceName: string; /** * The maximum disk size of the instance in bytes. */ readonly maxDiskSize: string; /** * Name of the Cloud SQL instance. This does not include the project ID. */ readonly name: string; /** * Configuration specific to on-premises instances. */ readonly onPremisesConfiguration: outputs.sqladmin.v1beta4.OnPremisesConfigurationResponse; /** * This field represents the report generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job */ readonly outOfDiskReport: outputs.sqladmin.v1beta4.SqlOutOfDiskReportResponse; /** * DEPRECATED: please use write_endpoint instead. * * @deprecated Output only. DEPRECATED: please use write_endpoint instead. */ readonly primaryDnsName: string; /** * The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. */ readonly project: string; /** * The link to service attachment of PSC instance. */ readonly pscServiceAttachmentLink: string; /** * The geographical region. Can be: * `us-central` (`FIRST_GEN` instances only) * `us-central1` (`SECOND_GEN` instances only) * `asia-east1` or `europe-west1`. Defaults to `us-central` or `us-central1` depending on the instance type. The region cannot be changed after instance creation. */ readonly region: string; /** * Configuration specific to failover replicas and read replicas. */ readonly replicaConfiguration: outputs.sqladmin.v1beta4.ReplicaConfigurationResponse; /** * The replicas of the instance. */ readonly replicaNames: string[]; /** * Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. */ readonly rootPassword: string; /** * The status indicating if instance satisfiesPzs. Reserved for future use. */ readonly satisfiesPzs: boolean; /** * The start time of any upcoming scheduled maintenance for this instance. */ readonly scheduledMaintenance: outputs.sqladmin.v1beta4.SqlScheduledMaintenanceResponse; /** * The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. */ readonly secondaryGceZone: string; /** * The URI of this resource. */ readonly selfLink: string; /** * SSL configuration. */ readonly serverCaCert: outputs.sqladmin.v1beta4.SslCertResponse; /** * The service account email address assigned to the instance. \This property is read-only. */ readonly serviceAccountEmailAddress: string; /** * The user settings. */ readonly settings: outputs.sqladmin.v1beta4.SettingsResponse; /** * The SQL network architecture for the instance. */ readonly sqlNetworkArchitecture: string; /** * The current serving state of the Cloud SQL instance. */ readonly state: string; /** * If the instance state is SUSPENDED, the reason for the suspension. */ readonly suspensionReason: string[]; /** * The dns name of the primary instance in a replication group. */ readonly writeEndpoint: string; } /** * Retrieves a resource containing information about a Cloud SQL instance. */ export declare function getInstanceOutput(args: GetInstanceOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output; export interface GetInstanceOutputArgs { instance: pulumi.Input; project?: pulumi.Input; }