1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. sql
  5. getDatabaseInstance
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi

gcp.sql.getDatabaseInstance

Explore with Pulumi AI

Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi

Use this data source to get information about a Cloud SQL instance.

Example Usage

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

const qa = gcp.sql.getDatabaseInstance({
    name: "test-sql-instance",
});
Copy
import pulumi
import pulumi_gcp as gcp

qa = gcp.sql.get_database_instance(name="test-sql-instance")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sql.LookupDatabaseInstance(ctx, &sql.LookupDatabaseInstanceArgs{
			Name: "test-sql-instance",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var qa = Gcp.Sql.GetDatabaseInstance.Invoke(new()
    {
        Name = "test-sql-instance",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.sql.SqlFunctions;
import com.pulumi.gcp.sql.inputs.GetDatabaseInstanceArgs;
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 = SqlFunctions.getDatabaseInstance(GetDatabaseInstanceArgs.builder()
            .name("test-sql-instance")
            .build());

    }
}
Copy
variables:
  qa:
    fn::invoke:
      function: gcp:sql:getDatabaseInstance
      arguments:
        name: test-sql-instance
Copy

Using getDatabaseInstance

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 getDatabaseInstance(args: GetDatabaseInstanceArgs, opts?: InvokeOptions): Promise<GetDatabaseInstanceResult>
function getDatabaseInstanceOutput(args: GetDatabaseInstanceOutputArgs, opts?: InvokeOptions): Output<GetDatabaseInstanceResult>
Copy
def get_database_instance(name: Optional[str] = None,
                          project: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetDatabaseInstanceResult
def get_database_instance_output(name: Optional[pulumi.Input[str]] = None,
                          project: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseInstanceResult]
Copy
func LookupDatabaseInstance(ctx *Context, args *LookupDatabaseInstanceArgs, opts ...InvokeOption) (*LookupDatabaseInstanceResult, error)
func LookupDatabaseInstanceOutput(ctx *Context, args *LookupDatabaseInstanceOutputArgs, opts ...InvokeOption) LookupDatabaseInstanceResultOutput
Copy

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

public static class GetDatabaseInstance 
{
    public static Task<GetDatabaseInstanceResult> InvokeAsync(GetDatabaseInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseInstanceResult> Invoke(GetDatabaseInstanceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDatabaseInstanceResult> getDatabaseInstance(GetDatabaseInstanceArgs args, InvokeOptions options)
public static Output<GetDatabaseInstanceResult> getDatabaseInstance(GetDatabaseInstanceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: gcp:sql/getDatabaseInstance:getDatabaseInstance
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The name of the instance.
Project string
The ID of the project in which the resource belongs.
Name This property is required. string
The name of the instance.
Project string
The ID of the project in which the resource belongs.
name This property is required. String
The name of the instance.
project String
The ID of the project in which the resource belongs.
name This property is required. string
The name of the instance.
project string
The ID of the project in which the resource belongs.
name This property is required. str
The name of the instance.
project str
The ID of the project in which the resource belongs.
name This property is required. String
The name of the instance.
project String
The ID of the project in which the resource belongs.

getDatabaseInstance Result

The following output properties are available:

AvailableMaintenanceVersions List<string>
Clones List<GetDatabaseInstanceClone>
ConnectionName string
DatabaseVersion string
DeletionProtection bool
DnsName string
EncryptionKeyName string
FirstIpAddress string
Id string
The provider-assigned unique ID for this managed resource.
InstanceType string
IpAddresses List<GetDatabaseInstanceIpAddress>
MaintenanceVersion string
MasterInstanceName string
Name string
PrivateIpAddress string
PscServiceAttachmentLink string
PublicIpAddress string
Region string
ReplicaConfigurations List<GetDatabaseInstanceReplicaConfiguration>
ReplicaNames List<string>
ReplicationClusters List<GetDatabaseInstanceReplicationCluster>
RestoreBackupContexts List<GetDatabaseInstanceRestoreBackupContext>
RootPassword string
SelfLink string
ServerCaCerts List<GetDatabaseInstanceServerCaCert>
ServiceAccountEmailAddress string
Settings List<GetDatabaseInstanceSetting>
Project string
AvailableMaintenanceVersions []string
Clones []GetDatabaseInstanceClone
ConnectionName string
DatabaseVersion string
DeletionProtection bool
DnsName string
EncryptionKeyName string
FirstIpAddress string
Id string
The provider-assigned unique ID for this managed resource.
InstanceType string
IpAddresses []GetDatabaseInstanceIpAddress
MaintenanceVersion string
MasterInstanceName string
Name string
PrivateIpAddress string
PscServiceAttachmentLink string
PublicIpAddress string
Region string
ReplicaConfigurations []GetDatabaseInstanceReplicaConfiguration
ReplicaNames []string
ReplicationClusters []GetDatabaseInstanceReplicationCluster
RestoreBackupContexts []GetDatabaseInstanceRestoreBackupContext
RootPassword string
SelfLink string
ServerCaCerts []GetDatabaseInstanceServerCaCert
ServiceAccountEmailAddress string
Settings []GetDatabaseInstanceSetting
Project string
availableMaintenanceVersions List<String>
clones List<GetDatabaseInstanceClone>
connectionName String
databaseVersion String
deletionProtection Boolean
dnsName String
encryptionKeyName String
firstIpAddress String
id String
The provider-assigned unique ID for this managed resource.
instanceType String
ipAddresses List<GetDatabaseInstanceIpAddress>
maintenanceVersion String
masterInstanceName String
name String
privateIpAddress String
pscServiceAttachmentLink String
publicIpAddress String
region String
replicaConfigurations List<GetDatabaseInstanceReplicaConfiguration>
replicaNames List<String>
replicationClusters List<GetDatabaseInstanceReplicationCluster>
restoreBackupContexts List<GetDatabaseInstanceRestoreBackupContext>
rootPassword String
selfLink String
serverCaCerts List<GetDatabaseInstanceServerCaCert>
serviceAccountEmailAddress String
settings List<GetDatabaseInstanceSetting>
project String
available_maintenance_versions Sequence[str]
clones Sequence[GetDatabaseInstanceClone]
connection_name str
database_version str
deletion_protection bool
dns_name str
encryption_key_name str
first_ip_address str
id str
The provider-assigned unique ID for this managed resource.
instance_type str
ip_addresses Sequence[GetDatabaseInstanceIpAddress]
maintenance_version str
master_instance_name str
name str
private_ip_address str
psc_service_attachment_link str
public_ip_address str
region str
replica_configurations Sequence[GetDatabaseInstanceReplicaConfiguration]
replica_names Sequence[str]
replication_clusters Sequence[GetDatabaseInstanceReplicationCluster]
restore_backup_contexts Sequence[GetDatabaseInstanceRestoreBackupContext]
root_password str
self_link str
server_ca_certs Sequence[GetDatabaseInstanceServerCaCert]
service_account_email_address str
settings Sequence[GetDatabaseInstanceSetting]
project str

Supporting Types

GetDatabaseInstanceClone

AllocatedIpRange This property is required. string
The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the cloned instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
DatabaseNames This property is required. List<string>
(SQL Server only, use with point_in_time) clone only the specified databases from the source instance. Clone all databases if empty.
PointInTime This property is required. string
The timestamp of the point in time that should be restored.
PreferredZone This property is required. string
(Point-in-time recovery for PostgreSQL only) Clone to an instance in the specified zone. If no zone is specified, clone to the same zone as the source instance.
SourceInstanceName This property is required. string
The name of the instance from which the point in time should be restored.
AllocatedIpRange This property is required. string
The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the cloned instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
DatabaseNames This property is required. []string
(SQL Server only, use with point_in_time) clone only the specified databases from the source instance. Clone all databases if empty.
PointInTime This property is required. string
The timestamp of the point in time that should be restored.
PreferredZone This property is required. string
(Point-in-time recovery for PostgreSQL only) Clone to an instance in the specified zone. If no zone is specified, clone to the same zone as the source instance.
SourceInstanceName This property is required. string
The name of the instance from which the point in time should be restored.
allocatedIpRange This property is required. String
The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the cloned instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
databaseNames This property is required. List<String>
(SQL Server only, use with point_in_time) clone only the specified databases from the source instance. Clone all databases if empty.
pointInTime This property is required. String
The timestamp of the point in time that should be restored.
preferredZone This property is required. String
(Point-in-time recovery for PostgreSQL only) Clone to an instance in the specified zone. If no zone is specified, clone to the same zone as the source instance.
sourceInstanceName This property is required. String
The name of the instance from which the point in time should be restored.
allocatedIpRange This property is required. string
The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the cloned instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
databaseNames This property is required. string[]
(SQL Server only, use with point_in_time) clone only the specified databases from the source instance. Clone all databases if empty.
pointInTime This property is required. string
The timestamp of the point in time that should be restored.
preferredZone This property is required. string
(Point-in-time recovery for PostgreSQL only) Clone to an instance in the specified zone. If no zone is specified, clone to the same zone as the source instance.
sourceInstanceName This property is required. string
The name of the instance from which the point in time should be restored.
allocated_ip_range This property is required. str
The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the cloned instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
database_names This property is required. Sequence[str]
(SQL Server only, use with point_in_time) clone only the specified databases from the source instance. Clone all databases if empty.
point_in_time This property is required. str
The timestamp of the point in time that should be restored.
preferred_zone This property is required. str
(Point-in-time recovery for PostgreSQL only) Clone to an instance in the specified zone. If no zone is specified, clone to the same zone as the source instance.
source_instance_name This property is required. str
The name of the instance from which the point in time should be restored.
allocatedIpRange This property is required. String
The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the cloned instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
databaseNames This property is required. List<String>
(SQL Server only, use with point_in_time) clone only the specified databases from the source instance. Clone all databases if empty.
pointInTime This property is required. String
The timestamp of the point in time that should be restored.
preferredZone This property is required. String
(Point-in-time recovery for PostgreSQL only) Clone to an instance in the specified zone. If no zone is specified, clone to the same zone as the source instance.
sourceInstanceName This property is required. String
The name of the instance from which the point in time should be restored.

GetDatabaseInstanceIpAddress

IpAddress This property is required. string
TimeToRetire This property is required. string
Type This property is required. string
IpAddress This property is required. string
TimeToRetire This property is required. string
Type This property is required. string
ipAddress This property is required. String
timeToRetire This property is required. String
type This property is required. String
ipAddress This property is required. string
timeToRetire This property is required. string
type This property is required. string
ip_address This property is required. str
time_to_retire This property is required. str
type This property is required. str
ipAddress This property is required. String
timeToRetire This property is required. String
type This property is required. String

GetDatabaseInstanceReplicaConfiguration

CaCertificate This property is required. string
PEM representation of the trusted CA's x509 certificate.
CascadableReplica This property is required. bool
Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it.
ClientCertificate This property is required. string
PEM representation of the replica's x509 certificate.
ClientKey This property is required. string
PEM representation of the replica's private key. The corresponding public key in encoded in the client_certificate.
ConnectRetryInterval This property is required. int
The number of seconds between connect retries. MySQL's default is 60 seconds.
DumpFilePath This property is required. string
Path to a SQL file in Google Cloud Storage from which replica instances are created. Format is gs://bucket/filename.
FailoverTarget This property is required. bool
Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. If the master instance fails, the replica instance will be promoted as the new master instance. Not supported for Postgres
MasterHeartbeatPeriod This property is required. int
Time in ms between replication heartbeats.
Password This property is required. string
Password for the replication connection.
SslCipher This property is required. string
Permissible ciphers for use in SSL encryption.
Username This property is required. string
Username for replication connection.
VerifyServerCertificate This property is required. bool
True if the master's common name value is checked during the SSL handshake.
CaCertificate This property is required. string
PEM representation of the trusted CA's x509 certificate.
CascadableReplica This property is required. bool
Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it.
ClientCertificate This property is required. string
PEM representation of the replica's x509 certificate.
ClientKey This property is required. string
PEM representation of the replica's private key. The corresponding public key in encoded in the client_certificate.
ConnectRetryInterval This property is required. int
The number of seconds between connect retries. MySQL's default is 60 seconds.
DumpFilePath This property is required. string
Path to a SQL file in Google Cloud Storage from which replica instances are created. Format is gs://bucket/filename.
FailoverTarget This property is required. bool
Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. If the master instance fails, the replica instance will be promoted as the new master instance. Not supported for Postgres
MasterHeartbeatPeriod This property is required. int
Time in ms between replication heartbeats.
Password This property is required. string
Password for the replication connection.
SslCipher This property is required. string
Permissible ciphers for use in SSL encryption.
Username This property is required. string
Username for replication connection.
VerifyServerCertificate This property is required. bool
True if the master's common name value is checked during the SSL handshake.
caCertificate This property is required. String
PEM representation of the trusted CA's x509 certificate.
cascadableReplica This property is required. Boolean
Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it.
clientCertificate This property is required. String
PEM representation of the replica's x509 certificate.
clientKey This property is required. String
PEM representation of the replica's private key. The corresponding public key in encoded in the client_certificate.
connectRetryInterval This property is required. Integer
The number of seconds between connect retries. MySQL's default is 60 seconds.
dumpFilePath This property is required. String
Path to a SQL file in Google Cloud Storage from which replica instances are created. Format is gs://bucket/filename.
failoverTarget This property is required. Boolean
Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. If the master instance fails, the replica instance will be promoted as the new master instance. Not supported for Postgres
masterHeartbeatPeriod This property is required. Integer
Time in ms between replication heartbeats.
password This property is required. String
Password for the replication connection.
sslCipher This property is required. String
Permissible ciphers for use in SSL encryption.
username This property is required. String
Username for replication connection.
verifyServerCertificate This property is required. Boolean
True if the master's common name value is checked during the SSL handshake.
caCertificate This property is required. string
PEM representation of the trusted CA's x509 certificate.
cascadableReplica This property is required. boolean
Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it.
clientCertificate This property is required. string
PEM representation of the replica's x509 certificate.
clientKey This property is required. string
PEM representation of the replica's private key. The corresponding public key in encoded in the client_certificate.
connectRetryInterval This property is required. number
The number of seconds between connect retries. MySQL's default is 60 seconds.
dumpFilePath This property is required. string
Path to a SQL file in Google Cloud Storage from which replica instances are created. Format is gs://bucket/filename.
failoverTarget This property is required. boolean
Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. If the master instance fails, the replica instance will be promoted as the new master instance. Not supported for Postgres
masterHeartbeatPeriod This property is required. number
Time in ms between replication heartbeats.
password This property is required. string
Password for the replication connection.
sslCipher This property is required. string
Permissible ciphers for use in SSL encryption.
username This property is required. string
Username for replication connection.
verifyServerCertificate This property is required. boolean
True if the master's common name value is checked during the SSL handshake.
ca_certificate This property is required. str
PEM representation of the trusted CA's x509 certificate.
cascadable_replica This property is required. bool
Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it.
client_certificate This property is required. str
PEM representation of the replica's x509 certificate.
client_key This property is required. str
PEM representation of the replica's private key. The corresponding public key in encoded in the client_certificate.
connect_retry_interval This property is required. int
The number of seconds between connect retries. MySQL's default is 60 seconds.
dump_file_path This property is required. str
Path to a SQL file in Google Cloud Storage from which replica instances are created. Format is gs://bucket/filename.
failover_target This property is required. bool
Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. If the master instance fails, the replica instance will be promoted as the new master instance. Not supported for Postgres
master_heartbeat_period This property is required. int
Time in ms between replication heartbeats.
password This property is required. str
Password for the replication connection.
ssl_cipher This property is required. str
Permissible ciphers for use in SSL encryption.
username This property is required. str
Username for replication connection.
verify_server_certificate This property is required. bool
True if the master's common name value is checked during the SSL handshake.
caCertificate This property is required. String
PEM representation of the trusted CA's x509 certificate.
cascadableReplica This property is required. Boolean
Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it.
clientCertificate This property is required. String
PEM representation of the replica's x509 certificate.
clientKey This property is required. String
PEM representation of the replica's private key. The corresponding public key in encoded in the client_certificate.
connectRetryInterval This property is required. Number
The number of seconds between connect retries. MySQL's default is 60 seconds.
dumpFilePath This property is required. String
Path to a SQL file in Google Cloud Storage from which replica instances are created. Format is gs://bucket/filename.
failoverTarget This property is required. Boolean
Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. If the master instance fails, the replica instance will be promoted as the new master instance. Not supported for Postgres
masterHeartbeatPeriod This property is required. Number
Time in ms between replication heartbeats.
password This property is required. String
Password for the replication connection.
sslCipher This property is required. String
Permissible ciphers for use in SSL encryption.
username This property is required. String
Username for replication connection.
verifyServerCertificate This property is required. Boolean
True if the master's common name value is checked during the SSL handshake.

GetDatabaseInstanceReplicationCluster

DrReplica This property is required. bool
Read-only field that indicates whether the replica is a DR replica.
FailoverDrReplicaName This property is required. string
If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. The standard format of this field is "your-project:your-instance". You can also set this field to "your-instance", but cloud SQL backend will convert it to the aforementioned standard format.
DrReplica This property is required. bool
Read-only field that indicates whether the replica is a DR replica.
FailoverDrReplicaName This property is required. string
If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. The standard format of this field is "your-project:your-instance". You can also set this field to "your-instance", but cloud SQL backend will convert it to the aforementioned standard format.
drReplica This property is required. Boolean
Read-only field that indicates whether the replica is a DR replica.
failoverDrReplicaName This property is required. String
If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. The standard format of this field is "your-project:your-instance". You can also set this field to "your-instance", but cloud SQL backend will convert it to the aforementioned standard format.
drReplica This property is required. boolean
Read-only field that indicates whether the replica is a DR replica.
failoverDrReplicaName This property is required. string
If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. The standard format of this field is "your-project:your-instance". You can also set this field to "your-instance", but cloud SQL backend will convert it to the aforementioned standard format.
dr_replica This property is required. bool
Read-only field that indicates whether the replica is a DR replica.
failover_dr_replica_name This property is required. str
If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. The standard format of this field is "your-project:your-instance". You can also set this field to "your-instance", but cloud SQL backend will convert it to the aforementioned standard format.
drReplica This property is required. Boolean
Read-only field that indicates whether the replica is a DR replica.
failoverDrReplicaName This property is required. String
If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. The standard format of this field is "your-project:your-instance". You can also set this field to "your-instance", but cloud SQL backend will convert it to the aforementioned standard format.

GetDatabaseInstanceRestoreBackupContext

BackupRunId This property is required. int
The ID of the backup run to restore from.
InstanceId This property is required. string
The ID of the instance that the backup was taken from.
Project This property is required. string
The ID of the project in which the resource belongs.
BackupRunId This property is required. int
The ID of the backup run to restore from.
InstanceId This property is required. string
The ID of the instance that the backup was taken from.
Project This property is required. string
The ID of the project in which the resource belongs.
backupRunId This property is required. Integer
The ID of the backup run to restore from.
instanceId This property is required. String
The ID of the instance that the backup was taken from.
project This property is required. String
The ID of the project in which the resource belongs.
backupRunId This property is required. number
The ID of the backup run to restore from.
instanceId This property is required. string
The ID of the instance that the backup was taken from.
project This property is required. string
The ID of the project in which the resource belongs.
backup_run_id This property is required. int
The ID of the backup run to restore from.
instance_id This property is required. str
The ID of the instance that the backup was taken from.
project This property is required. str
The ID of the project in which the resource belongs.
backupRunId This property is required. Number
The ID of the backup run to restore from.
instanceId This property is required. String
The ID of the instance that the backup was taken from.
project This property is required. String
The ID of the project in which the resource belongs.

GetDatabaseInstanceServerCaCert

Cert This property is required. string
The CA Certificate used to connect to the SQL Instance via SSL.
CommonName This property is required. string
The CN valid for the CA Cert.
CreateTime This property is required. string
Creation time of the CA Cert.
ExpirationTime This property is required. string
Expiration time of the CA Cert.
Sha1Fingerprint This property is required. string
SHA Fingerprint of the CA Cert.
Cert This property is required. string
The CA Certificate used to connect to the SQL Instance via SSL.
CommonName This property is required. string
The CN valid for the CA Cert.
CreateTime This property is required. string
Creation time of the CA Cert.
ExpirationTime This property is required. string
Expiration time of the CA Cert.
Sha1Fingerprint This property is required. string
SHA Fingerprint of the CA Cert.
cert This property is required. String
The CA Certificate used to connect to the SQL Instance via SSL.
commonName This property is required. String
The CN valid for the CA Cert.
createTime This property is required. String
Creation time of the CA Cert.
expirationTime This property is required. String
Expiration time of the CA Cert.
sha1Fingerprint This property is required. String
SHA Fingerprint of the CA Cert.
cert This property is required. string
The CA Certificate used to connect to the SQL Instance via SSL.
commonName This property is required. string
The CN valid for the CA Cert.
createTime This property is required. string
Creation time of the CA Cert.
expirationTime This property is required. string
Expiration time of the CA Cert.
sha1Fingerprint This property is required. string
SHA Fingerprint of the CA Cert.
cert This property is required. str
The CA Certificate used to connect to the SQL Instance via SSL.
common_name This property is required. str
The CN valid for the CA Cert.
create_time This property is required. str
Creation time of the CA Cert.
expiration_time This property is required. str
Expiration time of the CA Cert.
sha1_fingerprint This property is required. str
SHA Fingerprint of the CA Cert.
cert This property is required. String
The CA Certificate used to connect to the SQL Instance via SSL.
commonName This property is required. String
The CN valid for the CA Cert.
createTime This property is required. String
Creation time of the CA Cert.
expirationTime This property is required. String
Expiration time of the CA Cert.
sha1Fingerprint This property is required. String
SHA Fingerprint of the CA Cert.

GetDatabaseInstanceSetting

ActivationPolicy This property is required. string
This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND.
ActiveDirectoryConfigs This property is required. List<GetDatabaseInstanceSettingActiveDirectoryConfig>
AdvancedMachineFeatures This property is required. List<GetDatabaseInstanceSettingAdvancedMachineFeature>
AvailabilityType This property is required. string
The availability type of the Cloud SQL instance, high availability (REGIONAL) or single zone (ZONAL). For all instances, ensure that settings.backup_configuration.enabled is set to true. For MySQL instances, ensure that settings.backup_configuration.binary_log_enabled is set to true. For Postgres instances, ensure that settings.backup_configuration.point_in_time_recovery_enabled is set to true. Defaults to ZONAL.
BackupConfigurations This property is required. List<GetDatabaseInstanceSettingBackupConfiguration>
Collation This property is required. string
The name of server instance collation.
ConnectorEnforcement This property is required. string
Enables the enforcement of Cloud SQL Auth Proxy or Cloud SQL connectors for all the connections. If enabled, all the direct connections are rejected.
DataCacheConfigs This property is required. List<GetDatabaseInstanceSettingDataCacheConfig>
Data cache configurations.
DatabaseFlags This property is required. List<GetDatabaseInstanceSettingDatabaseFlag>
DeletionProtectionEnabled This property is required. bool
Configuration to protect against accidental instance deletion.
DenyMaintenancePeriods This property is required. List<GetDatabaseInstanceSettingDenyMaintenancePeriod>
DiskAutoresize This property is required. bool
Enables auto-resizing of the storage size. Defaults to true.
DiskAutoresizeLimit This property is required. int
The maximum size, in GB, to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
DiskSize This property is required. int
The size of data disk, in GB. Size of a running instance cannot be reduced but can be increased. The minimum value is 10GB.
DiskType This property is required. string
The type of data disk: PD_SSD or PD_HDD. Defaults to PD_SSD.
Edition This property is required. string
The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS.
EnableDataplexIntegration This property is required. bool
Enables Dataplex Integration.
EnableGoogleMlIntegration This property is required. bool
Enables Vertex AI Integration.
InsightsConfigs This property is required. List<GetDatabaseInstanceSettingInsightsConfig>
Configuration of Query Insights.
IpConfigurations This property is required. List<GetDatabaseInstanceSettingIpConfiguration>
LocationPreferences This property is required. List<GetDatabaseInstanceSettingLocationPreference>
MaintenanceWindows This property is required. List<GetDatabaseInstanceSettingMaintenanceWindow>
Declares a one-hour maintenance window when an Instance can automatically restart to apply updates. The maintenance window is specified in UTC time.
PasswordValidationPolicies This property is required. List<GetDatabaseInstanceSettingPasswordValidationPolicy>
PricingPlan This property is required. string
Pricing plan for this instance, can only be PER_USE.
SqlServerAuditConfigs This property is required. List<GetDatabaseInstanceSettingSqlServerAuditConfig>
Tier This property is required. string
The machine type to use. See tiers for more details and supported versions. Postgres supports only shared-core machine types, and custom machine types such as db-custom-2-13312. See the Custom Machine Type Documentation to learn about specifying custom machine types.
TimeZone This property is required. string
The time_zone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format.
UserLabels This property is required. Dictionary<string, string>
A set of key/value user label pairs to assign to the instance.
Version This property is required. int
Used to make sure changes to the settings block are atomic.
ActivationPolicy This property is required. string
This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND.
ActiveDirectoryConfigs This property is required. []GetDatabaseInstanceSettingActiveDirectoryConfig
AdvancedMachineFeatures This property is required. []GetDatabaseInstanceSettingAdvancedMachineFeature
AvailabilityType This property is required. string
The availability type of the Cloud SQL instance, high availability (REGIONAL) or single zone (ZONAL). For all instances, ensure that settings.backup_configuration.enabled is set to true. For MySQL instances, ensure that settings.backup_configuration.binary_log_enabled is set to true. For Postgres instances, ensure that settings.backup_configuration.point_in_time_recovery_enabled is set to true. Defaults to ZONAL.
BackupConfigurations This property is required. []GetDatabaseInstanceSettingBackupConfiguration
Collation This property is required. string
The name of server instance collation.
ConnectorEnforcement This property is required. string
Enables the enforcement of Cloud SQL Auth Proxy or Cloud SQL connectors for all the connections. If enabled, all the direct connections are rejected.
DataCacheConfigs This property is required. []GetDatabaseInstanceSettingDataCacheConfig
Data cache configurations.
DatabaseFlags This property is required. []GetDatabaseInstanceSettingDatabaseFlag
DeletionProtectionEnabled This property is required. bool
Configuration to protect against accidental instance deletion.
DenyMaintenancePeriods This property is required. []GetDatabaseInstanceSettingDenyMaintenancePeriod
DiskAutoresize This property is required. bool
Enables auto-resizing of the storage size. Defaults to true.
DiskAutoresizeLimit This property is required. int
The maximum size, in GB, to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
DiskSize This property is required. int
The size of data disk, in GB. Size of a running instance cannot be reduced but can be increased. The minimum value is 10GB.
DiskType This property is required. string
The type of data disk: PD_SSD or PD_HDD. Defaults to PD_SSD.
Edition This property is required. string
The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS.
EnableDataplexIntegration This property is required. bool
Enables Dataplex Integration.
EnableGoogleMlIntegration This property is required. bool
Enables Vertex AI Integration.
InsightsConfigs This property is required. []GetDatabaseInstanceSettingInsightsConfig
Configuration of Query Insights.
IpConfigurations This property is required. []GetDatabaseInstanceSettingIpConfiguration
LocationPreferences This property is required. []GetDatabaseInstanceSettingLocationPreference
MaintenanceWindows This property is required. []GetDatabaseInstanceSettingMaintenanceWindow
Declares a one-hour maintenance window when an Instance can automatically restart to apply updates. The maintenance window is specified in UTC time.
PasswordValidationPolicies This property is required. []GetDatabaseInstanceSettingPasswordValidationPolicy
PricingPlan This property is required. string
Pricing plan for this instance, can only be PER_USE.
SqlServerAuditConfigs This property is required. []GetDatabaseInstanceSettingSqlServerAuditConfig
Tier This property is required. string
The machine type to use. See tiers for more details and supported versions. Postgres supports only shared-core machine types, and custom machine types such as db-custom-2-13312. See the Custom Machine Type Documentation to learn about specifying custom machine types.
TimeZone This property is required. string
The time_zone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format.
UserLabels This property is required. map[string]string
A set of key/value user label pairs to assign to the instance.
Version This property is required. int
Used to make sure changes to the settings block are atomic.
activationPolicy This property is required. String
This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND.
activeDirectoryConfigs This property is required. List<GetDatabaseInstanceSettingActiveDirectoryConfig>
advancedMachineFeatures This property is required. List<GetDatabaseInstanceSettingAdvancedMachineFeature>
availabilityType This property is required. String
The availability type of the Cloud SQL instance, high availability (REGIONAL) or single zone (ZONAL). For all instances, ensure that settings.backup_configuration.enabled is set to true. For MySQL instances, ensure that settings.backup_configuration.binary_log_enabled is set to true. For Postgres instances, ensure that settings.backup_configuration.point_in_time_recovery_enabled is set to true. Defaults to ZONAL.
backupConfigurations This property is required. List<GetDatabaseInstanceSettingBackupConfiguration>
collation This property is required. String
The name of server instance collation.
connectorEnforcement This property is required. String
Enables the enforcement of Cloud SQL Auth Proxy or Cloud SQL connectors for all the connections. If enabled, all the direct connections are rejected.
dataCacheConfigs This property is required. List<GetDatabaseInstanceSettingDataCacheConfig>
Data cache configurations.
databaseFlags This property is required. List<GetDatabaseInstanceSettingDatabaseFlag>
deletionProtectionEnabled This property is required. Boolean
Configuration to protect against accidental instance deletion.
denyMaintenancePeriods This property is required. List<GetDatabaseInstanceSettingDenyMaintenancePeriod>
diskAutoresize This property is required. Boolean
Enables auto-resizing of the storage size. Defaults to true.
diskAutoresizeLimit This property is required. Integer
The maximum size, in GB, to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
diskSize This property is required. Integer
The size of data disk, in GB. Size of a running instance cannot be reduced but can be increased. The minimum value is 10GB.
diskType This property is required. String
The type of data disk: PD_SSD or PD_HDD. Defaults to PD_SSD.
edition This property is required. String
The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS.
enableDataplexIntegration This property is required. Boolean
Enables Dataplex Integration.
enableGoogleMlIntegration This property is required. Boolean
Enables Vertex AI Integration.
insightsConfigs This property is required. List<GetDatabaseInstanceSettingInsightsConfig>
Configuration of Query Insights.
ipConfigurations This property is required. List<GetDatabaseInstanceSettingIpConfiguration>
locationPreferences This property is required. List<GetDatabaseInstanceSettingLocationPreference>
maintenanceWindows This property is required. List<GetDatabaseInstanceSettingMaintenanceWindow>
Declares a one-hour maintenance window when an Instance can automatically restart to apply updates. The maintenance window is specified in UTC time.
passwordValidationPolicies This property is required. List<GetDatabaseInstanceSettingPasswordValidationPolicy>
pricingPlan This property is required. String
Pricing plan for this instance, can only be PER_USE.
sqlServerAuditConfigs This property is required. List<GetDatabaseInstanceSettingSqlServerAuditConfig>
tier This property is required. String
The machine type to use. See tiers for more details and supported versions. Postgres supports only shared-core machine types, and custom machine types such as db-custom-2-13312. See the Custom Machine Type Documentation to learn about specifying custom machine types.
timeZone This property is required. String
The time_zone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format.
userLabels This property is required. Map<String,String>
A set of key/value user label pairs to assign to the instance.
version This property is required. Integer
Used to make sure changes to the settings block are atomic.
activationPolicy This property is required. string
This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND.
activeDirectoryConfigs This property is required. GetDatabaseInstanceSettingActiveDirectoryConfig[]
advancedMachineFeatures This property is required. GetDatabaseInstanceSettingAdvancedMachineFeature[]
availabilityType This property is required. string
The availability type of the Cloud SQL instance, high availability (REGIONAL) or single zone (ZONAL). For all instances, ensure that settings.backup_configuration.enabled is set to true. For MySQL instances, ensure that settings.backup_configuration.binary_log_enabled is set to true. For Postgres instances, ensure that settings.backup_configuration.point_in_time_recovery_enabled is set to true. Defaults to ZONAL.
backupConfigurations This property is required. GetDatabaseInstanceSettingBackupConfiguration[]
collation This property is required. string
The name of server instance collation.
connectorEnforcement This property is required. string
Enables the enforcement of Cloud SQL Auth Proxy or Cloud SQL connectors for all the connections. If enabled, all the direct connections are rejected.
dataCacheConfigs This property is required. GetDatabaseInstanceSettingDataCacheConfig[]
Data cache configurations.
databaseFlags This property is required. GetDatabaseInstanceSettingDatabaseFlag[]
deletionProtectionEnabled This property is required. boolean
Configuration to protect against accidental instance deletion.
denyMaintenancePeriods This property is required. GetDatabaseInstanceSettingDenyMaintenancePeriod[]
diskAutoresize This property is required. boolean
Enables auto-resizing of the storage size. Defaults to true.
diskAutoresizeLimit This property is required. number
The maximum size, in GB, to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
diskSize This property is required. number
The size of data disk, in GB. Size of a running instance cannot be reduced but can be increased. The minimum value is 10GB.
diskType This property is required. string
The type of data disk: PD_SSD or PD_HDD. Defaults to PD_SSD.
edition This property is required. string
The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS.
enableDataplexIntegration This property is required. boolean
Enables Dataplex Integration.
enableGoogleMlIntegration This property is required. boolean
Enables Vertex AI Integration.
insightsConfigs This property is required. GetDatabaseInstanceSettingInsightsConfig[]
Configuration of Query Insights.
ipConfigurations This property is required. GetDatabaseInstanceSettingIpConfiguration[]
locationPreferences This property is required. GetDatabaseInstanceSettingLocationPreference[]
maintenanceWindows This property is required. GetDatabaseInstanceSettingMaintenanceWindow[]
Declares a one-hour maintenance window when an Instance can automatically restart to apply updates. The maintenance window is specified in UTC time.
passwordValidationPolicies This property is required. GetDatabaseInstanceSettingPasswordValidationPolicy[]
pricingPlan This property is required. string
Pricing plan for this instance, can only be PER_USE.
sqlServerAuditConfigs This property is required. GetDatabaseInstanceSettingSqlServerAuditConfig[]
tier This property is required. string
The machine type to use. See tiers for more details and supported versions. Postgres supports only shared-core machine types, and custom machine types such as db-custom-2-13312. See the Custom Machine Type Documentation to learn about specifying custom machine types.
timeZone This property is required. string
The time_zone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format.
userLabels This property is required. {[key: string]: string}
A set of key/value user label pairs to assign to the instance.
version This property is required. number
Used to make sure changes to the settings block are atomic.
activation_policy This property is required. str
This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND.
active_directory_configs This property is required. Sequence[GetDatabaseInstanceSettingActiveDirectoryConfig]
advanced_machine_features This property is required. Sequence[GetDatabaseInstanceSettingAdvancedMachineFeature]
availability_type This property is required. str
The availability type of the Cloud SQL instance, high availability (REGIONAL) or single zone (ZONAL). For all instances, ensure that settings.backup_configuration.enabled is set to true. For MySQL instances, ensure that settings.backup_configuration.binary_log_enabled is set to true. For Postgres instances, ensure that settings.backup_configuration.point_in_time_recovery_enabled is set to true. Defaults to ZONAL.
backup_configurations This property is required. Sequence[GetDatabaseInstanceSettingBackupConfiguration]
collation This property is required. str
The name of server instance collation.
connector_enforcement This property is required. str
Enables the enforcement of Cloud SQL Auth Proxy or Cloud SQL connectors for all the connections. If enabled, all the direct connections are rejected.
data_cache_configs This property is required. Sequence[GetDatabaseInstanceSettingDataCacheConfig]
Data cache configurations.
database_flags This property is required. Sequence[GetDatabaseInstanceSettingDatabaseFlag]
deletion_protection_enabled This property is required. bool
Configuration to protect against accidental instance deletion.
deny_maintenance_periods This property is required. Sequence[GetDatabaseInstanceSettingDenyMaintenancePeriod]
disk_autoresize This property is required. bool
Enables auto-resizing of the storage size. Defaults to true.
disk_autoresize_limit This property is required. int
The maximum size, in GB, to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
disk_size This property is required. int
The size of data disk, in GB. Size of a running instance cannot be reduced but can be increased. The minimum value is 10GB.
disk_type This property is required. str
The type of data disk: PD_SSD or PD_HDD. Defaults to PD_SSD.
edition This property is required. str
The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS.
enable_dataplex_integration This property is required. bool
Enables Dataplex Integration.
enable_google_ml_integration This property is required. bool
Enables Vertex AI Integration.
insights_configs This property is required. Sequence[GetDatabaseInstanceSettingInsightsConfig]
Configuration of Query Insights.
ip_configurations This property is required. Sequence[GetDatabaseInstanceSettingIpConfiguration]
location_preferences This property is required. Sequence[GetDatabaseInstanceSettingLocationPreference]
maintenance_windows This property is required. Sequence[GetDatabaseInstanceSettingMaintenanceWindow]
Declares a one-hour maintenance window when an Instance can automatically restart to apply updates. The maintenance window is specified in UTC time.
password_validation_policies This property is required. Sequence[GetDatabaseInstanceSettingPasswordValidationPolicy]
pricing_plan This property is required. str
Pricing plan for this instance, can only be PER_USE.
sql_server_audit_configs This property is required. Sequence[GetDatabaseInstanceSettingSqlServerAuditConfig]
tier This property is required. str
The machine type to use. See tiers for more details and supported versions. Postgres supports only shared-core machine types, and custom machine types such as db-custom-2-13312. See the Custom Machine Type Documentation to learn about specifying custom machine types.
time_zone This property is required. str
The time_zone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format.
user_labels This property is required. Mapping[str, str]
A set of key/value user label pairs to assign to the instance.
version This property is required. int
Used to make sure changes to the settings block are atomic.
activationPolicy This property is required. String
This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND.
activeDirectoryConfigs This property is required. List<Property Map>
advancedMachineFeatures This property is required. List<Property Map>
availabilityType This property is required. String
The availability type of the Cloud SQL instance, high availability (REGIONAL) or single zone (ZONAL). For all instances, ensure that settings.backup_configuration.enabled is set to true. For MySQL instances, ensure that settings.backup_configuration.binary_log_enabled is set to true. For Postgres instances, ensure that settings.backup_configuration.point_in_time_recovery_enabled is set to true. Defaults to ZONAL.
backupConfigurations This property is required. List<Property Map>
collation This property is required. String
The name of server instance collation.
connectorEnforcement This property is required. String
Enables the enforcement of Cloud SQL Auth Proxy or Cloud SQL connectors for all the connections. If enabled, all the direct connections are rejected.
dataCacheConfigs This property is required. List<Property Map>
Data cache configurations.
databaseFlags This property is required. List<Property Map>
deletionProtectionEnabled This property is required. Boolean
Configuration to protect against accidental instance deletion.
denyMaintenancePeriods This property is required. List<Property Map>
diskAutoresize This property is required. Boolean
Enables auto-resizing of the storage size. Defaults to true.
diskAutoresizeLimit This property is required. Number
The maximum size, in GB, to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
diskSize This property is required. Number
The size of data disk, in GB. Size of a running instance cannot be reduced but can be increased. The minimum value is 10GB.
diskType This property is required. String
The type of data disk: PD_SSD or PD_HDD. Defaults to PD_SSD.
edition This property is required. String
The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS.
enableDataplexIntegration This property is required. Boolean
Enables Dataplex Integration.
enableGoogleMlIntegration This property is required. Boolean
Enables Vertex AI Integration.
insightsConfigs This property is required. List<Property Map>
Configuration of Query Insights.
ipConfigurations This property is required. List<Property Map>
locationPreferences This property is required. List<Property Map>
maintenanceWindows This property is required. List<Property Map>
Declares a one-hour maintenance window when an Instance can automatically restart to apply updates. The maintenance window is specified in UTC time.
passwordValidationPolicies This property is required. List<Property Map>
pricingPlan This property is required. String
Pricing plan for this instance, can only be PER_USE.
sqlServerAuditConfigs This property is required. List<Property Map>
tier This property is required. String
The machine type to use. See tiers for more details and supported versions. Postgres supports only shared-core machine types, and custom machine types such as db-custom-2-13312. See the Custom Machine Type Documentation to learn about specifying custom machine types.
timeZone This property is required. String
The time_zone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format.
userLabels This property is required. Map<String>
A set of key/value user label pairs to assign to the instance.
version This property is required. Number
Used to make sure changes to the settings block are atomic.

GetDatabaseInstanceSettingActiveDirectoryConfig

Domain This property is required. string
Domain name of the Active Directory for SQL Server (e.g., mydomain.com).
Domain This property is required. string
Domain name of the Active Directory for SQL Server (e.g., mydomain.com).
domain This property is required. String
Domain name of the Active Directory for SQL Server (e.g., mydomain.com).
domain This property is required. string
Domain name of the Active Directory for SQL Server (e.g., mydomain.com).
domain This property is required. str
Domain name of the Active Directory for SQL Server (e.g., mydomain.com).
domain This property is required. String
Domain name of the Active Directory for SQL Server (e.g., mydomain.com).

GetDatabaseInstanceSettingAdvancedMachineFeature

ThreadsPerCore This property is required. int
The number of threads per physical core. Can be 1 or 2.
ThreadsPerCore This property is required. int
The number of threads per physical core. Can be 1 or 2.
threadsPerCore This property is required. Integer
The number of threads per physical core. Can be 1 or 2.
threadsPerCore This property is required. number
The number of threads per physical core. Can be 1 or 2.
threads_per_core This property is required. int
The number of threads per physical core. Can be 1 or 2.
threadsPerCore This property is required. Number
The number of threads per physical core. Can be 1 or 2.

GetDatabaseInstanceSettingBackupConfiguration

BackupRetentionSettings This property is required. List<GetDatabaseInstanceSettingBackupConfigurationBackupRetentionSetting>
BinaryLogEnabled This property is required. bool
True if binary logging is enabled. If settings.backup_configuration.enabled is false, this must be as well. Can only be used with MySQL.
Enabled This property is required. bool
True if backup configuration is enabled.
Location This property is required. string
Location of the backup configuration.
PointInTimeRecoveryEnabled This property is required. bool
True if Point-in-time recovery is enabled.
StartTime This property is required. string
HH:MM format time indicating when backup configuration starts.
TransactionLogRetentionDays This property is required. int
The number of days of transaction logs we retain for point in time restore, from 1-7. (For PostgreSQL Enterprise Plus instances, from 1 to 35.)
BackupRetentionSettings This property is required. []GetDatabaseInstanceSettingBackupConfigurationBackupRetentionSetting
BinaryLogEnabled This property is required. bool
True if binary logging is enabled. If settings.backup_configuration.enabled is false, this must be as well. Can only be used with MySQL.
Enabled This property is required. bool
True if backup configuration is enabled.
Location This property is required. string
Location of the backup configuration.
PointInTimeRecoveryEnabled This property is required. bool
True if Point-in-time recovery is enabled.
StartTime This property is required. string
HH:MM format time indicating when backup configuration starts.
TransactionLogRetentionDays This property is required. int
The number of days of transaction logs we retain for point in time restore, from 1-7. (For PostgreSQL Enterprise Plus instances, from 1 to 35.)
backupRetentionSettings This property is required. List<GetDatabaseInstanceSettingBackupConfigurationBackupRetentionSetting>
binaryLogEnabled This property is required. Boolean
True if binary logging is enabled. If settings.backup_configuration.enabled is false, this must be as well. Can only be used with MySQL.
enabled This property is required. Boolean
True if backup configuration is enabled.
location This property is required. String
Location of the backup configuration.
pointInTimeRecoveryEnabled This property is required. Boolean
True if Point-in-time recovery is enabled.
startTime This property is required. String
HH:MM format time indicating when backup configuration starts.
transactionLogRetentionDays This property is required. Integer
The number of days of transaction logs we retain for point in time restore, from 1-7. (For PostgreSQL Enterprise Plus instances, from 1 to 35.)
backupRetentionSettings This property is required. GetDatabaseInstanceSettingBackupConfigurationBackupRetentionSetting[]
binaryLogEnabled This property is required. boolean
True if binary logging is enabled. If settings.backup_configuration.enabled is false, this must be as well. Can only be used with MySQL.
enabled This property is required. boolean
True if backup configuration is enabled.
location This property is required. string
Location of the backup configuration.
pointInTimeRecoveryEnabled This property is required. boolean
True if Point-in-time recovery is enabled.
startTime This property is required. string
HH:MM format time indicating when backup configuration starts.
transactionLogRetentionDays This property is required. number
The number of days of transaction logs we retain for point in time restore, from 1-7. (For PostgreSQL Enterprise Plus instances, from 1 to 35.)
backup_retention_settings This property is required. Sequence[GetDatabaseInstanceSettingBackupConfigurationBackupRetentionSetting]
binary_log_enabled This property is required. bool
True if binary logging is enabled. If settings.backup_configuration.enabled is false, this must be as well. Can only be used with MySQL.
enabled This property is required. bool
True if backup configuration is enabled.
location This property is required. str
Location of the backup configuration.
point_in_time_recovery_enabled This property is required. bool
True if Point-in-time recovery is enabled.
start_time This property is required. str
HH:MM format time indicating when backup configuration starts.
transaction_log_retention_days This property is required. int
The number of days of transaction logs we retain for point in time restore, from 1-7. (For PostgreSQL Enterprise Plus instances, from 1 to 35.)
backupRetentionSettings This property is required. List<Property Map>
binaryLogEnabled This property is required. Boolean
True if binary logging is enabled. If settings.backup_configuration.enabled is false, this must be as well. Can only be used with MySQL.
enabled This property is required. Boolean
True if backup configuration is enabled.
location This property is required. String
Location of the backup configuration.
pointInTimeRecoveryEnabled This property is required. Boolean
True if Point-in-time recovery is enabled.
startTime This property is required. String
HH:MM format time indicating when backup configuration starts.
transactionLogRetentionDays This property is required. Number
The number of days of transaction logs we retain for point in time restore, from 1-7. (For PostgreSQL Enterprise Plus instances, from 1 to 35.)

GetDatabaseInstanceSettingBackupConfigurationBackupRetentionSetting

RetainedBackups This property is required. int
Number of backups to retain.
RetentionUnit This property is required. string
The unit that 'retainedBackups' represents. Defaults to COUNT
RetainedBackups This property is required. int
Number of backups to retain.
RetentionUnit This property is required. string
The unit that 'retainedBackups' represents. Defaults to COUNT
retainedBackups This property is required. Integer
Number of backups to retain.
retentionUnit This property is required. String
The unit that 'retainedBackups' represents. Defaults to COUNT
retainedBackups This property is required. number
Number of backups to retain.
retentionUnit This property is required. string
The unit that 'retainedBackups' represents. Defaults to COUNT
retained_backups This property is required. int
Number of backups to retain.
retention_unit This property is required. str
The unit that 'retainedBackups' represents. Defaults to COUNT
retainedBackups This property is required. Number
Number of backups to retain.
retentionUnit This property is required. String
The unit that 'retainedBackups' represents. Defaults to COUNT

GetDatabaseInstanceSettingDataCacheConfig

DataCacheEnabled This property is required. bool
Whether data cache is enabled for the instance.
DataCacheEnabled This property is required. bool
Whether data cache is enabled for the instance.
dataCacheEnabled This property is required. Boolean
Whether data cache is enabled for the instance.
dataCacheEnabled This property is required. boolean
Whether data cache is enabled for the instance.
data_cache_enabled This property is required. bool
Whether data cache is enabled for the instance.
dataCacheEnabled This property is required. Boolean
Whether data cache is enabled for the instance.

GetDatabaseInstanceSettingDatabaseFlag

Name This property is required. string
The name of the instance.
Value This property is required. string
Value of the flag.
Name This property is required. string
The name of the instance.
Value This property is required. string
Value of the flag.
name This property is required. String
The name of the instance.
value This property is required. String
Value of the flag.
name This property is required. string
The name of the instance.
value This property is required. string
Value of the flag.
name This property is required. str
The name of the instance.
value This property is required. str
Value of the flag.
name This property is required. String
The name of the instance.
value This property is required. String
Value of the flag.

GetDatabaseInstanceSettingDenyMaintenancePeriod

EndDate This property is required. string
End date before which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
StartDate This property is required. string
Start date after which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
Time This property is required. string
Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00
EndDate This property is required. string
End date before which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
StartDate This property is required. string
Start date after which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
Time This property is required. string
Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00
endDate This property is required. String
End date before which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
startDate This property is required. String
Start date after which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
time This property is required. String
Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00
endDate This property is required. string
End date before which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
startDate This property is required. string
Start date after which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
time This property is required. string
Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00
end_date This property is required. str
End date before which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
start_date This property is required. str
Start date after which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
time This property is required. str
Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00
endDate This property is required. String
End date before which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
startDate This property is required. String
Start date after which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
time This property is required. String
Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00

GetDatabaseInstanceSettingInsightsConfig

QueryInsightsEnabled This property is required. bool
True if Query Insights feature is enabled.
QueryPlansPerMinute This property is required. int
Number of query execution plans captured by Insights per minute for all queries combined. Between 0 and 20. Default to 5. For Enterprise Plus instances, from 0 to 200.
QueryStringLength This property is required. int
Maximum query length stored in bytes. Between 256 and 4500. Default to 1024. For Enterprise Plus instances, from 1 to 1048576.
RecordApplicationTags This property is required. bool
True if Query Insights will record application tags from query when enabled.
RecordClientAddress This property is required. bool
True if Query Insights will record client address when enabled.
QueryInsightsEnabled This property is required. bool
True if Query Insights feature is enabled.
QueryPlansPerMinute This property is required. int
Number of query execution plans captured by Insights per minute for all queries combined. Between 0 and 20. Default to 5. For Enterprise Plus instances, from 0 to 200.
QueryStringLength This property is required. int
Maximum query length stored in bytes. Between 256 and 4500. Default to 1024. For Enterprise Plus instances, from 1 to 1048576.
RecordApplicationTags This property is required. bool
True if Query Insights will record application tags from query when enabled.
RecordClientAddress This property is required. bool
True if Query Insights will record client address when enabled.
queryInsightsEnabled This property is required. Boolean
True if Query Insights feature is enabled.
queryPlansPerMinute This property is required. Integer
Number of query execution plans captured by Insights per minute for all queries combined. Between 0 and 20. Default to 5. For Enterprise Plus instances, from 0 to 200.
queryStringLength This property is required. Integer
Maximum query length stored in bytes. Between 256 and 4500. Default to 1024. For Enterprise Plus instances, from 1 to 1048576.
recordApplicationTags This property is required. Boolean
True if Query Insights will record application tags from query when enabled.
recordClientAddress This property is required. Boolean
True if Query Insights will record client address when enabled.
queryInsightsEnabled This property is required. boolean
True if Query Insights feature is enabled.
queryPlansPerMinute This property is required. number
Number of query execution plans captured by Insights per minute for all queries combined. Between 0 and 20. Default to 5. For Enterprise Plus instances, from 0 to 200.
queryStringLength This property is required. number
Maximum query length stored in bytes. Between 256 and 4500. Default to 1024. For Enterprise Plus instances, from 1 to 1048576.
recordApplicationTags This property is required. boolean
True if Query Insights will record application tags from query when enabled.
recordClientAddress This property is required. boolean
True if Query Insights will record client address when enabled.
query_insights_enabled This property is required. bool
True if Query Insights feature is enabled.
query_plans_per_minute This property is required. int
Number of query execution plans captured by Insights per minute for all queries combined. Between 0 and 20. Default to 5. For Enterprise Plus instances, from 0 to 200.
query_string_length This property is required. int
Maximum query length stored in bytes. Between 256 and 4500. Default to 1024. For Enterprise Plus instances, from 1 to 1048576.
record_application_tags This property is required. bool
True if Query Insights will record application tags from query when enabled.
record_client_address This property is required. bool
True if Query Insights will record client address when enabled.
queryInsightsEnabled This property is required. Boolean
True if Query Insights feature is enabled.
queryPlansPerMinute This property is required. Number
Number of query execution plans captured by Insights per minute for all queries combined. Between 0 and 20. Default to 5. For Enterprise Plus instances, from 0 to 200.
queryStringLength This property is required. Number
Maximum query length stored in bytes. Between 256 and 4500. Default to 1024. For Enterprise Plus instances, from 1 to 1048576.
recordApplicationTags This property is required. Boolean
True if Query Insights will record application tags from query when enabled.
recordClientAddress This property is required. Boolean
True if Query Insights will record client address when enabled.

GetDatabaseInstanceSettingIpConfiguration

AllocatedIpRange This property is required. string
The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
AuthorizedNetworks This property is required. List<GetDatabaseInstanceSettingIpConfigurationAuthorizedNetwork>
EnablePrivatePathForGoogleCloudServices This property is required. bool
Whether Google Cloud services such as BigQuery are allowed to access data in this Cloud SQL instance over a private IP connection. SQLSERVER database type is not supported.
Ipv4Enabled This property is required. bool
Whether this Cloud SQL instance should be assigned a public IPV4 address. At least ipv4_enabled must be enabled or a private_network must be configured.
PrivateNetwork This property is required. string
The VPC network from which the Cloud SQL instance is accessible for private IP. For example, projects/myProject/global/networks/default. Specifying a network enables private IP. At least ipv4_enabled must be enabled or a private_network must be configured. This setting can be updated, but it cannot be removed after it is set.
PscConfigs This property is required. List<GetDatabaseInstanceSettingIpConfigurationPscConfig>
PSC settings for a Cloud SQL instance.
ServerCaMode This property is required. string
Specify how the server certificate's Certificate Authority is hosted.
ServerCaPool This property is required. string
The resource name of the server CA pool for an instance with "CUSTOMER_MANAGED_CAS_CA" as the "server_ca_mode".
SslMode This property is required. string
Specify how SSL connection should be enforced in DB connections.
AllocatedIpRange This property is required. string
The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
AuthorizedNetworks This property is required. []GetDatabaseInstanceSettingIpConfigurationAuthorizedNetwork
EnablePrivatePathForGoogleCloudServices This property is required. bool
Whether Google Cloud services such as BigQuery are allowed to access data in this Cloud SQL instance over a private IP connection. SQLSERVER database type is not supported.
Ipv4Enabled This property is required. bool
Whether this Cloud SQL instance should be assigned a public IPV4 address. At least ipv4_enabled must be enabled or a private_network must be configured.
PrivateNetwork This property is required. string
The VPC network from which the Cloud SQL instance is accessible for private IP. For example, projects/myProject/global/networks/default. Specifying a network enables private IP. At least ipv4_enabled must be enabled or a private_network must be configured. This setting can be updated, but it cannot be removed after it is set.
PscConfigs This property is required. []GetDatabaseInstanceSettingIpConfigurationPscConfig
PSC settings for a Cloud SQL instance.
ServerCaMode This property is required. string
Specify how the server certificate's Certificate Authority is hosted.
ServerCaPool This property is required. string
The resource name of the server CA pool for an instance with "CUSTOMER_MANAGED_CAS_CA" as the "server_ca_mode".
SslMode This property is required. string
Specify how SSL connection should be enforced in DB connections.
allocatedIpRange This property is required. String
The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
authorizedNetworks This property is required. List<GetDatabaseInstanceSettingIpConfigurationAuthorizedNetwork>
enablePrivatePathForGoogleCloudServices This property is required. Boolean
Whether Google Cloud services such as BigQuery are allowed to access data in this Cloud SQL instance over a private IP connection. SQLSERVER database type is not supported.
ipv4Enabled This property is required. Boolean
Whether this Cloud SQL instance should be assigned a public IPV4 address. At least ipv4_enabled must be enabled or a private_network must be configured.
privateNetwork This property is required. String
The VPC network from which the Cloud SQL instance is accessible for private IP. For example, projects/myProject/global/networks/default. Specifying a network enables private IP. At least ipv4_enabled must be enabled or a private_network must be configured. This setting can be updated, but it cannot be removed after it is set.
pscConfigs This property is required. List<GetDatabaseInstanceSettingIpConfigurationPscConfig>
PSC settings for a Cloud SQL instance.
serverCaMode This property is required. String
Specify how the server certificate's Certificate Authority is hosted.
serverCaPool This property is required. String
The resource name of the server CA pool for an instance with "CUSTOMER_MANAGED_CAS_CA" as the "server_ca_mode".
sslMode This property is required. String
Specify how SSL connection should be enforced in DB connections.
allocatedIpRange This property is required. string
The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
authorizedNetworks This property is required. GetDatabaseInstanceSettingIpConfigurationAuthorizedNetwork[]
enablePrivatePathForGoogleCloudServices This property is required. boolean
Whether Google Cloud services such as BigQuery are allowed to access data in this Cloud SQL instance over a private IP connection. SQLSERVER database type is not supported.
ipv4Enabled This property is required. boolean
Whether this Cloud SQL instance should be assigned a public IPV4 address. At least ipv4_enabled must be enabled or a private_network must be configured.
privateNetwork This property is required. string
The VPC network from which the Cloud SQL instance is accessible for private IP. For example, projects/myProject/global/networks/default. Specifying a network enables private IP. At least ipv4_enabled must be enabled or a private_network must be configured. This setting can be updated, but it cannot be removed after it is set.
pscConfigs This property is required. GetDatabaseInstanceSettingIpConfigurationPscConfig[]
PSC settings for a Cloud SQL instance.
serverCaMode This property is required. string
Specify how the server certificate's Certificate Authority is hosted.
serverCaPool This property is required. string
The resource name of the server CA pool for an instance with "CUSTOMER_MANAGED_CAS_CA" as the "server_ca_mode".
sslMode This property is required. string
Specify how SSL connection should be enforced in DB connections.
allocated_ip_range This property is required. str
The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
authorized_networks This property is required. Sequence[GetDatabaseInstanceSettingIpConfigurationAuthorizedNetwork]
enable_private_path_for_google_cloud_services This property is required. bool
Whether Google Cloud services such as BigQuery are allowed to access data in this Cloud SQL instance over a private IP connection. SQLSERVER database type is not supported.
ipv4_enabled This property is required. bool
Whether this Cloud SQL instance should be assigned a public IPV4 address. At least ipv4_enabled must be enabled or a private_network must be configured.
private_network This property is required. str
The VPC network from which the Cloud SQL instance is accessible for private IP. For example, projects/myProject/global/networks/default. Specifying a network enables private IP. At least ipv4_enabled must be enabled or a private_network must be configured. This setting can be updated, but it cannot be removed after it is set.
psc_configs This property is required. Sequence[GetDatabaseInstanceSettingIpConfigurationPscConfig]
PSC settings for a Cloud SQL instance.
server_ca_mode This property is required. str
Specify how the server certificate's Certificate Authority is hosted.
server_ca_pool This property is required. str
The resource name of the server CA pool for an instance with "CUSTOMER_MANAGED_CAS_CA" as the "server_ca_mode".
ssl_mode This property is required. str
Specify how SSL connection should be enforced in DB connections.
allocatedIpRange This property is required. String
The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
authorizedNetworks This property is required. List<Property Map>
enablePrivatePathForGoogleCloudServices This property is required. Boolean
Whether Google Cloud services such as BigQuery are allowed to access data in this Cloud SQL instance over a private IP connection. SQLSERVER database type is not supported.
ipv4Enabled This property is required. Boolean
Whether this Cloud SQL instance should be assigned a public IPV4 address. At least ipv4_enabled must be enabled or a private_network must be configured.
privateNetwork This property is required. String
The VPC network from which the Cloud SQL instance is accessible for private IP. For example, projects/myProject/global/networks/default. Specifying a network enables private IP. At least ipv4_enabled must be enabled or a private_network must be configured. This setting can be updated, but it cannot be removed after it is set.
pscConfigs This property is required. List<Property Map>
PSC settings for a Cloud SQL instance.
serverCaMode This property is required. String
Specify how the server certificate's Certificate Authority is hosted.
serverCaPool This property is required. String
The resource name of the server CA pool for an instance with "CUSTOMER_MANAGED_CAS_CA" as the "server_ca_mode".
sslMode This property is required. String
Specify how SSL connection should be enforced in DB connections.

GetDatabaseInstanceSettingIpConfigurationAuthorizedNetwork

ExpirationTime This property is required. string
Name This property is required. string
The name of the instance.
Value This property is required. string
ExpirationTime This property is required. string
Name This property is required. string
The name of the instance.
Value This property is required. string
expirationTime This property is required. String
name This property is required. String
The name of the instance.
value This property is required. String
expirationTime This property is required. string
name This property is required. string
The name of the instance.
value This property is required. string
expiration_time This property is required. str
name This property is required. str
The name of the instance.
value This property is required. str
expirationTime This property is required. String
name This property is required. String
The name of the instance.
value This property is required. String

GetDatabaseInstanceSettingIpConfigurationPscConfig

AllowedConsumerProjects This property is required. List<string>
List of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
PscAutoConnections This property is required. List<GetDatabaseInstanceSettingIpConfigurationPscConfigPscAutoConnection>
A comma-separated list of networks or a comma-separated list of network-project pairs. Each project in this list is represented by a project number (numeric) or by a project ID (alphanumeric). This allows Private Service Connect connections to be created automatically for the specified networks.
PscEnabled This property is required. bool
Whether PSC connectivity is enabled for this instance.
AllowedConsumerProjects This property is required. []string
List of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
PscAutoConnections This property is required. []GetDatabaseInstanceSettingIpConfigurationPscConfigPscAutoConnection
A comma-separated list of networks or a comma-separated list of network-project pairs. Each project in this list is represented by a project number (numeric) or by a project ID (alphanumeric). This allows Private Service Connect connections to be created automatically for the specified networks.
PscEnabled This property is required. bool
Whether PSC connectivity is enabled for this instance.
allowedConsumerProjects This property is required. List<String>
List of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
pscAutoConnections This property is required. List<GetDatabaseInstanceSettingIpConfigurationPscConfigPscAutoConnection>
A comma-separated list of networks or a comma-separated list of network-project pairs. Each project in this list is represented by a project number (numeric) or by a project ID (alphanumeric). This allows Private Service Connect connections to be created automatically for the specified networks.
pscEnabled This property is required. Boolean
Whether PSC connectivity is enabled for this instance.
allowedConsumerProjects This property is required. string[]
List of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
pscAutoConnections This property is required. GetDatabaseInstanceSettingIpConfigurationPscConfigPscAutoConnection[]
A comma-separated list of networks or a comma-separated list of network-project pairs. Each project in this list is represented by a project number (numeric) or by a project ID (alphanumeric). This allows Private Service Connect connections to be created automatically for the specified networks.
pscEnabled This property is required. boolean
Whether PSC connectivity is enabled for this instance.
allowed_consumer_projects This property is required. Sequence[str]
List of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
psc_auto_connections This property is required. Sequence[GetDatabaseInstanceSettingIpConfigurationPscConfigPscAutoConnection]
A comma-separated list of networks or a comma-separated list of network-project pairs. Each project in this list is represented by a project number (numeric) or by a project ID (alphanumeric). This allows Private Service Connect connections to be created automatically for the specified networks.
psc_enabled This property is required. bool
Whether PSC connectivity is enabled for this instance.
allowedConsumerProjects This property is required. List<String>
List of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
pscAutoConnections This property is required. List<Property Map>
A comma-separated list of networks or a comma-separated list of network-project pairs. Each project in this list is represented by a project number (numeric) or by a project ID (alphanumeric). This allows Private Service Connect connections to be created automatically for the specified networks.
pscEnabled This property is required. Boolean
Whether PSC connectivity is enabled for this instance.

GetDatabaseInstanceSettingIpConfigurationPscConfigPscAutoConnection

ConsumerNetwork This property is required. string
The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. The consumer host project of this network might be different from the consumer service project.
ConsumerServiceProjectId This property is required. string
The project ID of consumer service project of this consumer endpoint.
ConsumerNetwork This property is required. string
The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. The consumer host project of this network might be different from the consumer service project.
ConsumerServiceProjectId This property is required. string
The project ID of consumer service project of this consumer endpoint.
consumerNetwork This property is required. String
The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. The consumer host project of this network might be different from the consumer service project.
consumerServiceProjectId This property is required. String
The project ID of consumer service project of this consumer endpoint.
consumerNetwork This property is required. string
The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. The consumer host project of this network might be different from the consumer service project.
consumerServiceProjectId This property is required. string
The project ID of consumer service project of this consumer endpoint.
consumer_network This property is required. str
The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. The consumer host project of this network might be different from the consumer service project.
consumer_service_project_id This property is required. str
The project ID of consumer service project of this consumer endpoint.
consumerNetwork This property is required. String
The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. The consumer host project of this network might be different from the consumer service project.
consumerServiceProjectId This property is required. String
The project ID of consumer service project of this consumer endpoint.

GetDatabaseInstanceSettingLocationPreference

FollowGaeApplication This property is required. string
A Google App Engine application whose zone to remain in. Must be in the same region as this instance.
SecondaryZone This property is required. string
The preferred Compute Engine zone for the secondary/failover
Zone This property is required. string
The preferred compute engine zone.
FollowGaeApplication This property is required. string
A Google App Engine application whose zone to remain in. Must be in the same region as this instance.
SecondaryZone This property is required. string
The preferred Compute Engine zone for the secondary/failover
Zone This property is required. string
The preferred compute engine zone.
followGaeApplication This property is required. String
A Google App Engine application whose zone to remain in. Must be in the same region as this instance.
secondaryZone This property is required. String
The preferred Compute Engine zone for the secondary/failover
zone This property is required. String
The preferred compute engine zone.
followGaeApplication This property is required. string
A Google App Engine application whose zone to remain in. Must be in the same region as this instance.
secondaryZone This property is required. string
The preferred Compute Engine zone for the secondary/failover
zone This property is required. string
The preferred compute engine zone.
follow_gae_application This property is required. str
A Google App Engine application whose zone to remain in. Must be in the same region as this instance.
secondary_zone This property is required. str
The preferred Compute Engine zone for the secondary/failover
zone This property is required. str
The preferred compute engine zone.
followGaeApplication This property is required. String
A Google App Engine application whose zone to remain in. Must be in the same region as this instance.
secondaryZone This property is required. String
The preferred Compute Engine zone for the secondary/failover
zone This property is required. String
The preferred compute engine zone.

GetDatabaseInstanceSettingMaintenanceWindow

Day This property is required. int
Day of week (1-7), starting on Monday
Hour This property is required. int
Hour of day (0-23), ignored if day not set
UpdateTrack This property is required. string
Receive updates after one week (canary) or after two weeks (stable) or after five weeks (week5) of notification.
Day This property is required. int
Day of week (1-7), starting on Monday
Hour This property is required. int
Hour of day (0-23), ignored if day not set
UpdateTrack This property is required. string
Receive updates after one week (canary) or after two weeks (stable) or after five weeks (week5) of notification.
day This property is required. Integer
Day of week (1-7), starting on Monday
hour This property is required. Integer
Hour of day (0-23), ignored if day not set
updateTrack This property is required. String
Receive updates after one week (canary) or after two weeks (stable) or after five weeks (week5) of notification.
day This property is required. number
Day of week (1-7), starting on Monday
hour This property is required. number
Hour of day (0-23), ignored if day not set
updateTrack This property is required. string
Receive updates after one week (canary) or after two weeks (stable) or after five weeks (week5) of notification.
day This property is required. int
Day of week (1-7), starting on Monday
hour This property is required. int
Hour of day (0-23), ignored if day not set
update_track This property is required. str
Receive updates after one week (canary) or after two weeks (stable) or after five weeks (week5) of notification.
day This property is required. Number
Day of week (1-7), starting on Monday
hour This property is required. Number
Hour of day (0-23), ignored if day not set
updateTrack This property is required. String
Receive updates after one week (canary) or after two weeks (stable) or after five weeks (week5) of notification.

GetDatabaseInstanceSettingPasswordValidationPolicy

Complexity This property is required. string
Password complexity.
DisallowUsernameSubstring This property is required. bool
Disallow username as a part of the password.
EnablePasswordPolicy This property is required. bool
Whether the password policy is enabled or not.
MinLength This property is required. int
Minimum number of characters allowed.
PasswordChangeInterval This property is required. string
Minimum interval after which the password can be changed. This flag is only supported for PostgresSQL.
ReuseInterval This property is required. int
Number of previous passwords that cannot be reused.
Complexity This property is required. string
Password complexity.
DisallowUsernameSubstring This property is required. bool
Disallow username as a part of the password.
EnablePasswordPolicy This property is required. bool
Whether the password policy is enabled or not.
MinLength This property is required. int
Minimum number of characters allowed.
PasswordChangeInterval This property is required. string
Minimum interval after which the password can be changed. This flag is only supported for PostgresSQL.
ReuseInterval This property is required. int
Number of previous passwords that cannot be reused.
complexity This property is required. String
Password complexity.
disallowUsernameSubstring This property is required. Boolean
Disallow username as a part of the password.
enablePasswordPolicy This property is required. Boolean
Whether the password policy is enabled or not.
minLength This property is required. Integer
Minimum number of characters allowed.
passwordChangeInterval This property is required. String
Minimum interval after which the password can be changed. This flag is only supported for PostgresSQL.
reuseInterval This property is required. Integer
Number of previous passwords that cannot be reused.
complexity This property is required. string
Password complexity.
disallowUsernameSubstring This property is required. boolean
Disallow username as a part of the password.
enablePasswordPolicy This property is required. boolean
Whether the password policy is enabled or not.
minLength This property is required. number
Minimum number of characters allowed.
passwordChangeInterval This property is required. string
Minimum interval after which the password can be changed. This flag is only supported for PostgresSQL.
reuseInterval This property is required. number
Number of previous passwords that cannot be reused.
complexity This property is required. str
Password complexity.
disallow_username_substring This property is required. bool
Disallow username as a part of the password.
enable_password_policy This property is required. bool
Whether the password policy is enabled or not.
min_length This property is required. int
Minimum number of characters allowed.
password_change_interval This property is required. str
Minimum interval after which the password can be changed. This flag is only supported for PostgresSQL.
reuse_interval This property is required. int
Number of previous passwords that cannot be reused.
complexity This property is required. String
Password complexity.
disallowUsernameSubstring This property is required. Boolean
Disallow username as a part of the password.
enablePasswordPolicy This property is required. Boolean
Whether the password policy is enabled or not.
minLength This property is required. Number
Minimum number of characters allowed.
passwordChangeInterval This property is required. String
Minimum interval after which the password can be changed. This flag is only supported for PostgresSQL.
reuseInterval This property is required. Number
Number of previous passwords that cannot be reused.

GetDatabaseInstanceSettingSqlServerAuditConfig

Bucket This property is required. string
The name of the destination bucket (e.g., gs://mybucket).
RetentionInterval This property is required. string
How long to keep generated audit files. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s"..
UploadInterval This property is required. string
How often to upload generated audit files. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
Bucket This property is required. string
The name of the destination bucket (e.g., gs://mybucket).
RetentionInterval This property is required. string
How long to keep generated audit files. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s"..
UploadInterval This property is required. string
How often to upload generated audit files. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
bucket This property is required. String
The name of the destination bucket (e.g., gs://mybucket).
retentionInterval This property is required. String
How long to keep generated audit files. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s"..
uploadInterval This property is required. String
How often to upload generated audit files. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
bucket This property is required. string
The name of the destination bucket (e.g., gs://mybucket).
retentionInterval This property is required. string
How long to keep generated audit files. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s"..
uploadInterval This property is required. string
How often to upload generated audit files. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
bucket This property is required. str
The name of the destination bucket (e.g., gs://mybucket).
retention_interval This property is required. str
How long to keep generated audit files. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s"..
upload_interval This property is required. str
How often to upload generated audit files. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
bucket This property is required. String
The name of the destination bucket (e.g., gs://mybucket).
retentionInterval This property is required. String
How long to keep generated audit files. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s"..
uploadInterval This property is required. String
How often to upload generated audit files. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

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.
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi