Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
gcp.sql.getDatabaseInstance
Explore with Pulumi AI
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",
});
import pulumi
import pulumi_gcp as gcp
qa = gcp.sql.get_database_instance(name="test-sql-instance")
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
})
}
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",
});
});
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());
}
}
variables:
qa:
fn::invoke:
function: gcp:sql:getDatabaseInstance
arguments:
name: test-sql-instance
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>
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]
func LookupDatabaseInstance(ctx *Context, args *LookupDatabaseInstanceArgs, opts ...InvokeOption) (*LookupDatabaseInstanceResult, error)
func LookupDatabaseInstanceOutput(ctx *Context, args *LookupDatabaseInstanceOutputArgs, opts ...InvokeOption) LookupDatabaseInstanceResultOutput
> 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)
}
public static CompletableFuture<GetDatabaseInstanceResult> getDatabaseInstance(GetDatabaseInstanceArgs args, InvokeOptions options)
public static Output<GetDatabaseInstanceResult> getDatabaseInstance(GetDatabaseInstanceArgs args, InvokeOptions options)
fn::invoke:
function: gcp:sql/getDatabaseInstance:getDatabaseInstance
arguments:
# arguments dictionary
The following arguments are supported:
getDatabaseInstance Result
The following output properties are available:
- Available
Maintenance List<string>Versions - Clones
List<Get
Database Instance Clone> - Connection
Name string - Database
Version string - Deletion
Protection bool - Dns
Name string - Encryption
Key stringName - First
Ip stringAddress - Id string
- The provider-assigned unique ID for this managed resource.
- Instance
Type string - Ip
Addresses List<GetDatabase Instance Ip Address> - Maintenance
Version string - Master
Instance stringName - Name string
- Private
Ip stringAddress - Psc
Service stringAttachment Link - Public
Ip stringAddress - Region string
- Replica
Configurations List<GetDatabase Instance Replica Configuration> - Replica
Names List<string> - Replication
Clusters List<GetDatabase Instance Replication Cluster> - Restore
Backup List<GetContexts Database Instance Restore Backup Context> - Root
Password string - Self
Link string - Server
Ca List<GetCerts Database Instance Server Ca Cert> - Service
Account stringEmail Address - Settings
List<Get
Database Instance Setting> - Project string
- Available
Maintenance []stringVersions - Clones
[]Get
Database Instance Clone - Connection
Name string - Database
Version string - Deletion
Protection bool - Dns
Name string - Encryption
Key stringName - First
Ip stringAddress - Id string
- The provider-assigned unique ID for this managed resource.
- Instance
Type string - Ip
Addresses []GetDatabase Instance Ip Address - Maintenance
Version string - Master
Instance stringName - Name string
- Private
Ip stringAddress - Psc
Service stringAttachment Link - Public
Ip stringAddress - Region string
- Replica
Configurations []GetDatabase Instance Replica Configuration - Replica
Names []string - Replication
Clusters []GetDatabase Instance Replication Cluster - Restore
Backup []GetContexts Database Instance Restore Backup Context - Root
Password string - Self
Link string - Server
Ca []GetCerts Database Instance Server Ca Cert - Service
Account stringEmail Address - Settings
[]Get
Database Instance Setting - Project string
- available
Maintenance List<String>Versions - clones
List<Get
Database Instance Clone> - connection
Name String - database
Version String - deletion
Protection Boolean - dns
Name String - encryption
Key StringName - first
Ip StringAddress - id String
- The provider-assigned unique ID for this managed resource.
- instance
Type String - ip
Addresses List<GetDatabase Instance Ip Address> - maintenance
Version String - master
Instance StringName - name String
- private
Ip StringAddress - psc
Service StringAttachment Link - public
Ip StringAddress - region String
- replica
Configurations List<GetDatabase Instance Replica Configuration> - replica
Names List<String> - replication
Clusters List<GetDatabase Instance Replication Cluster> - restore
Backup List<GetContexts Database Instance Restore Backup Context> - root
Password String - self
Link String - server
Ca List<GetCerts Database Instance Server Ca Cert> - service
Account StringEmail Address - settings
List<Get
Database Instance Setting> - project String
- available
Maintenance string[]Versions - clones
Get
Database Instance Clone[] - connection
Name string - database
Version string - deletion
Protection boolean - dns
Name string - encryption
Key stringName - first
Ip stringAddress - id string
- The provider-assigned unique ID for this managed resource.
- instance
Type string - ip
Addresses GetDatabase Instance Ip Address[] - maintenance
Version string - master
Instance stringName - name string
- private
Ip stringAddress - psc
Service stringAttachment Link - public
Ip stringAddress - region string
- replica
Configurations GetDatabase Instance Replica Configuration[] - replica
Names string[] - replication
Clusters GetDatabase Instance Replication Cluster[] - restore
Backup GetContexts Database Instance Restore Backup Context[] - root
Password string - self
Link string - server
Ca GetCerts Database Instance Server Ca Cert[] - service
Account stringEmail Address - settings
Get
Database Instance Setting[] - project string
- available_
maintenance_ Sequence[str]versions - clones
Sequence[Get
Database Instance Clone] - connection_
name str - database_
version str - deletion_
protection bool - dns_
name str - encryption_
key_ strname - first_
ip_ straddress - id str
- The provider-assigned unique ID for this managed resource.
- instance_
type str - ip_
addresses Sequence[GetDatabase Instance Ip Address] - maintenance_
version str - master_
instance_ strname - name str
- private_
ip_ straddress - psc_
service_ strattachment_ link - public_
ip_ straddress - region str
- replica_
configurations Sequence[GetDatabase Instance Replica Configuration] - replica_
names Sequence[str] - replication_
clusters Sequence[GetDatabase Instance Replication Cluster] - restore_
backup_ Sequence[Getcontexts Database Instance Restore Backup Context] - root_
password str - self_
link str - server_
ca_ Sequence[Getcerts Database Instance Server Ca Cert] - service_
account_ stremail_ address - settings
Sequence[Get
Database Instance Setting] - project str
- available
Maintenance List<String>Versions - clones List<Property Map>
- connection
Name String - database
Version String - deletion
Protection Boolean - dns
Name String - encryption
Key StringName - first
Ip StringAddress - id String
- The provider-assigned unique ID for this managed resource.
- instance
Type String - ip
Addresses List<Property Map> - maintenance
Version String - master
Instance StringName - name String
- private
Ip StringAddress - psc
Service StringAttachment Link - public
Ip StringAddress - region String
- replica
Configurations List<Property Map> - replica
Names List<String> - replication
Clusters List<Property Map> - restore
Backup List<Property Map>Contexts - root
Password String - self
Link String - server
Ca List<Property Map>Certs - service
Account StringEmail Address - settings List<Property Map>
- project String
Supporting Types
GetDatabaseInstanceClone
- Allocated
Ip Range 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?.
- Database
Names 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.
- Point
In Time This property is required. string - The timestamp of the point in time that should be restored.
- Preferred
Zone 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.
- Source
Instance Name 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. 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?.
- Database
Names 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.
- Point
In Time This property is required. string - The timestamp of the point in time that should be restored.
- Preferred
Zone 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.
- Source
Instance Name 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. 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?.
- database
Names 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.
- point
In Time This property is required. String - The timestamp of the point in time that should be restored.
- preferred
Zone 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.
- source
Instance Name 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. 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?.
- database
Names 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.
- point
In Time This property is required. string - The timestamp of the point in time that should be restored.
- preferred
Zone 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.
- source
Instance Name 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.
- allocated
Ip Range 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?.
- database
Names 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.
- point
In Time This property is required. String - The timestamp of the point in time that should be restored.
- preferred
Zone 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.
- source
Instance Name This property is required. String - The name of the instance from which the point in time should be restored.
GetDatabaseInstanceIpAddress
- Ip
Address This property is required. string - Time
To Retire This property is required. string - Type
This property is required. string
- Ip
Address This property is required. string - Time
To Retire This property is required. string - Type
This property is required. string
- ip
Address This property is required. String - time
To Retire This property is required. String - type
This property is required. String
- ip
Address This property is required. string - time
To Retire 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
- ip
Address This property is required. String - time
To Retire This property is required. String - type
This property is required. String
GetDatabaseInstanceReplicaConfiguration
- Ca
Certificate This property is required. string - 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. string - PEM representation of the replica's x509 certificate.
- Client
Key This property is required. string - 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. string - 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. string - Password for the replication connection.
- Ssl
Cipher This property is required. string - Permissible ciphers for use in SSL encryption.
- Username
This property is required. string - 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.
- Ca
Certificate This property is required. string - 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. string - PEM representation of the replica's x509 certificate.
- Client
Key This property is required. string - 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. string - 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. string - Password for the replication connection.
- Ssl
Cipher This property is required. string - Permissible ciphers for use in SSL encryption.
- Username
This property is required. string - 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.
- ca
Certificate This property is required. String - PEM representation of the trusted CA's x509 certificate.
- cascadable
Replica 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.
- client
Certificate This property is required. String - PEM representation of the replica's x509 certificate.
- client
Key This property is required. String - 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. Integer - The number of seconds between connect retries. MySQL's default is 60 seconds.
- dump
File Path 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.
- failover
Target 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
- master
Heartbeat Period This property is required. Integer - Time in ms between replication heartbeats.
- password
This property is required. String - Password for the replication connection.
- ssl
Cipher This property is required. String - Permissible ciphers for use in SSL encryption.
- username
This property is required. String - Username for replication connection.
- verify
Server Certificate 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. string - PEM representation of the trusted CA's x509 certificate.
- cascadable
Replica 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.
- client
Certificate This property is required. string - PEM representation of the replica's x509 certificate.
- client
Key This property is required. string - 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. number - The number of seconds between connect retries. MySQL's default is 60 seconds.
- dump
File Path 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.
- failover
Target 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
- master
Heartbeat Period This property is required. number - Time in ms between replication heartbeats.
- password
This property is required. string - Password for the replication connection.
- ssl
Cipher This property is required. string - Permissible ciphers for use in SSL encryption.
- username
This property is required. string - Username for replication connection.
- verify
Server Certificate 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.
- ca
Certificate This property is required. String - PEM representation of the trusted CA's x509 certificate.
- cascadable
Replica 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.
- client
Certificate This property is required. String - PEM representation of the replica's x509 certificate.
- client
Key This property is required. String - 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. Number - The number of seconds between connect retries. MySQL's default is 60 seconds.
- dump
File Path 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.
- failover
Target 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
- master
Heartbeat Period This property is required. Number - Time in ms between replication heartbeats.
- password
This property is required. String - Password for the replication connection.
- ssl
Cipher This property is required. String - Permissible ciphers for use in SSL encryption.
- username
This property is required. String - Username for replication connection.
- verify
Server Certificate This property is required. Boolean - True if the master's common name value is checked during the SSL handshake.
GetDatabaseInstanceReplicationCluster
- 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. 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. 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. Boolean - Read-only field that indicates whether the replica is a DR replica.
- failover
Dr Replica Name 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. boolean - Read-only field that indicates whether the replica is a DR replica.
- failover
Dr Replica Name 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.
- dr
Replica This property is required. Boolean - Read-only field that indicates whether the replica is a DR replica.
- failover
Dr Replica Name 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
- Backup
Run Id This property is required. int - The ID of the backup run to restore from.
- Instance
Id 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. 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. Integer - The ID of the backup run to restore from.
- instance
Id 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. number - The ID of the backup run to restore from.
- instance
Id 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.
- backup
Run Id This property is required. Number - The ID of the backup run to restore from.
- instance
Id 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.
- Common
Name This property is required. string - The CN valid for the CA Cert.
- Create
Time This property is required. string - Creation time of the CA Cert.
- Expiration
Time 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.
- Common
Name This property is required. string - The CN valid for the CA Cert.
- Create
Time This property is required. string - Creation time of the CA Cert.
- Expiration
Time 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.
- common
Name This property is required. String - The CN valid for the CA Cert.
- create
Time This property is required. String - Creation time of the CA Cert.
- expiration
Time 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.
- common
Name This property is required. string - The CN valid for the CA Cert.
- create
Time This property is required. string - Creation time of the CA Cert.
- expiration
Time 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.
- common
Name This property is required. String - The CN valid for the CA Cert.
- create
Time This property is required. String - Creation time of the CA Cert.
- expiration
Time This property is required. String - Expiration time of the CA Cert.
- sha1Fingerprint
This property is required. String - SHA Fingerprint of the CA Cert.
GetDatabaseInstanceSetting
- Activation
Policy This property is required. string - This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND.
- Active
Directory Configs This property is required. List<GetDatabase Instance Setting Active Directory Config> - Advanced
Machine Features This property is required. List<GetDatabase Instance Setting Advanced Machine Feature> - Availability
Type 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.
- Backup
Configurations This property is required. List<GetDatabase Instance Setting Backup Configuration> - Collation
This property is required. string - The name of server instance collation.
- Connector
Enforcement 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.
- Data
Cache Configs This property is required. List<GetDatabase Instance Setting Data Cache Config> - Data cache configurations.
- Database
Flags This property is required. List<GetDatabase Instance Setting Database Flag> - Deletion
Protection Enabled This property is required. bool - Configuration to protect against accidental instance deletion.
- Deny
Maintenance Periods This property is required. List<GetDatabase Instance Setting Deny Maintenance Period> - 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. 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.
- 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. List<GetDatabase Instance Setting Insights Config> - Configuration of Query Insights.
- Ip
Configurations This property is required. List<GetDatabase Instance Setting Ip Configuration> - Location
Preferences This property is required. List<GetDatabase Instance Setting Location Preference> - Maintenance
Windows This property is required. List<GetDatabase Instance Setting Maintenance Window> - 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. List<GetDatabase Instance Setting Password Validation Policy> - Pricing
Plan This property is required. string - Pricing plan for this instance, can only be PER_USE.
- Sql
Server Audit Configs This property is required. List<GetDatabase Instance Setting Sql Server Audit Config> - 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.
- Time
Zone 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.
- User
Labels 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.
- Activation
Policy This property is required. string - This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND.
- Active
Directory Configs This property is required. []GetDatabase Instance Setting Active Directory Config - Advanced
Machine Features This property is required. []GetDatabase Instance Setting Advanced Machine Feature - Availability
Type 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.
- Backup
Configurations This property is required. []GetDatabase Instance Setting Backup Configuration - Collation
This property is required. string - The name of server instance collation.
- Connector
Enforcement 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.
- Data
Cache Configs This property is required. []GetDatabase Instance Setting Data Cache Config - Data cache configurations.
- Database
Flags This property is required. []GetDatabase Instance Setting Database Flag - Deletion
Protection Enabled This property is required. bool - Configuration to protect against accidental instance deletion.
- Deny
Maintenance Periods This property is required. []GetDatabase Instance Setting Deny Maintenance Period - 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. 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.
- 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. []GetDatabase Instance Setting Insights Config - Configuration of Query Insights.
- Ip
Configurations This property is required. []GetDatabase Instance Setting Ip Configuration - Location
Preferences This property is required. []GetDatabase Instance Setting Location Preference - Maintenance
Windows This property is required. []GetDatabase Instance Setting Maintenance Window - 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. []GetDatabase Instance Setting Password Validation Policy - Pricing
Plan This property is required. string - Pricing plan for this instance, can only be PER_USE.
- Sql
Server Audit Configs This property is required. []GetDatabase Instance Setting Sql Server Audit Config - 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.
- Time
Zone 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.
- User
Labels 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.
- activation
Policy This property is required. String - This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND.
- active
Directory Configs This property is required. List<GetDatabase Instance Setting Active Directory Config> - advanced
Machine Features This property is required. List<GetDatabase Instance Setting Advanced Machine Feature> - availability
Type 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.
- backup
Configurations This property is required. List<GetDatabase Instance Setting Backup Configuration> - collation
This property is required. String - The name of server instance collation.
- connector
Enforcement 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.
- data
Cache Configs This property is required. List<GetDatabase Instance Setting Data Cache Config> - Data cache configurations.
- database
Flags This property is required. List<GetDatabase Instance Setting Database Flag> - deletion
Protection Enabled This property is required. Boolean - Configuration to protect against accidental instance deletion.
- deny
Maintenance Periods This property is required. List<GetDatabase Instance Setting Deny Maintenance Period> - disk
Autoresize This property is required. Boolean - Enables auto-resizing of the storage size. Defaults to true.
- disk
Autoresize Limit 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.
- disk
Size 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.
- disk
Type 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.
- enable
Dataplex Integration This property is required. Boolean - Enables Dataplex Integration.
- enable
Google Ml Integration This property is required. Boolean - Enables Vertex AI Integration.
- insights
Configs This property is required. List<GetDatabase Instance Setting Insights Config> - Configuration of Query Insights.
- ip
Configurations This property is required. List<GetDatabase Instance Setting Ip Configuration> - location
Preferences This property is required. List<GetDatabase Instance Setting Location Preference> - maintenance
Windows This property is required. List<GetDatabase Instance Setting Maintenance Window> - 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. List<GetDatabase Instance Setting Password Validation Policy> - pricing
Plan This property is required. String - Pricing plan for this instance, can only be PER_USE.
- sql
Server Audit Configs This property is required. List<GetDatabase Instance Setting Sql Server Audit Config> - 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.
- time
Zone 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.
- user
Labels 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.
- activation
Policy This property is required. string - This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND.
- active
Directory Configs This property is required. GetDatabase Instance Setting Active Directory Config[] - advanced
Machine Features This property is required. GetDatabase Instance Setting Advanced Machine Feature[] - availability
Type 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.
- backup
Configurations This property is required. GetDatabase Instance Setting Backup Configuration[] - collation
This property is required. string - The name of server instance collation.
- connector
Enforcement 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.
- data
Cache Configs This property is required. GetDatabase Instance Setting Data Cache Config[] - Data cache configurations.
- database
Flags This property is required. GetDatabase Instance Setting Database Flag[] - deletion
Protection Enabled This property is required. boolean - Configuration to protect against accidental instance deletion.
- deny
Maintenance Periods This property is required. GetDatabase Instance Setting Deny Maintenance Period[] - disk
Autoresize This property is required. boolean - Enables auto-resizing of the storage size. Defaults to true.
- disk
Autoresize Limit 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.
- disk
Size 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.
- disk
Type 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.
- enable
Dataplex Integration This property is required. boolean - Enables Dataplex Integration.
- enable
Google Ml Integration This property is required. boolean - Enables Vertex AI Integration.
- insights
Configs This property is required. GetDatabase Instance Setting Insights Config[] - Configuration of Query Insights.
- ip
Configurations This property is required. GetDatabase Instance Setting Ip Configuration[] - location
Preferences This property is required. GetDatabase Instance Setting Location Preference[] - maintenance
Windows This property is required. GetDatabase Instance Setting Maintenance Window[] - 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. GetDatabase Instance Setting Password Validation Policy[] - pricing
Plan This property is required. string - Pricing plan for this instance, can only be PER_USE.
- sql
Server Audit Configs This property is required. GetDatabase Instance Setting Sql Server Audit Config[] - 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.
- time
Zone 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.
- user
Labels 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[GetDatabase Instance Setting Active Directory Config] - advanced_
machine_ features This property is required. Sequence[GetDatabase Instance Setting Advanced Machine Feature] - 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[GetDatabase Instance Setting Backup Configuration] - 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[GetDatabase Instance Setting Data Cache Config] - Data cache configurations.
- database_
flags This property is required. Sequence[GetDatabase Instance Setting Database Flag] - deletion_
protection_ enabled This property is required. bool - Configuration to protect against accidental instance deletion.
- deny_
maintenance_ periods This property is required. Sequence[GetDatabase Instance Setting Deny Maintenance Period] - 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[GetDatabase Instance Setting Insights Config] - Configuration of Query Insights.
- ip_
configurations This property is required. Sequence[GetDatabase Instance Setting Ip Configuration] - location_
preferences This property is required. Sequence[GetDatabase Instance Setting Location Preference] - maintenance_
windows This property is required. Sequence[GetDatabase Instance Setting Maintenance Window] - 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[GetDatabase Instance Setting Password Validation Policy] - 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[GetDatabase Instance Setting Sql Server Audit Config] - 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.
- activation
Policy This property is required. String - This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND.
- active
Directory Configs This property is required. List<Property Map> - advanced
Machine Features This property is required. List<Property Map> - availability
Type 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.
- backup
Configurations This property is required. List<Property Map> - collation
This property is required. String - The name of server instance collation.
- connector
Enforcement 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.
- data
Cache Configs This property is required. List<Property Map> - Data cache configurations.
- database
Flags This property is required. List<Property Map> - deletion
Protection Enabled This property is required. Boolean - Configuration to protect against accidental instance deletion.
- deny
Maintenance Periods This property is required. List<Property Map> - disk
Autoresize This property is required. Boolean - Enables auto-resizing of the storage size. Defaults to true.
- disk
Autoresize Limit 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.
- disk
Size 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.
- disk
Type 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.
- enable
Dataplex Integration This property is required. Boolean - Enables Dataplex Integration.
- enable
Google Ml Integration This property is required. Boolean - Enables Vertex AI Integration.
- insights
Configs This property is required. List<Property Map> - Configuration of Query Insights.
- ip
Configurations This property is required. List<Property Map> - location
Preferences This property is required. List<Property Map> - maintenance
Windows 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.
- password
Validation Policies This property is required. List<Property Map> - pricing
Plan This property is required. String - Pricing plan for this instance, can only be PER_USE.
- sql
Server Audit Configs 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.
- time
Zone 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.
- user
Labels 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
- Threads
Per Core This property is required. int - 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.
- threads
Per Core This property is required. Integer - The number of threads per physical core. Can be 1 or 2.
- threads
Per Core 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.
- threads
Per Core This property is required. Number - The number of threads per physical core. Can be 1 or 2.
GetDatabaseInstanceSettingBackupConfiguration
- Backup
Retention Settings This property is required. List<GetDatabase Instance Setting Backup Configuration Backup Retention Setting> - 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. string - 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. string - 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.)
- Backup
Retention Settings This property is required. []GetDatabase Instance Setting Backup Configuration Backup Retention Setting - 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. string - 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. string - 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.)
- backup
Retention Settings This property is required. List<GetDatabase Instance Setting Backup Configuration Backup Retention Setting> - binary
Log Enabled 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.
- point
In Time Recovery Enabled This property is required. Boolean - True if Point-in-time recovery is enabled.
- start
Time This property is required. String - HH:MM format time indicating when backup configuration starts.
- transaction
Log Retention Days 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.)
- backup
Retention Settings This property is required. GetDatabase Instance Setting Backup Configuration Backup Retention Setting[] - binary
Log Enabled 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.
- point
In Time Recovery Enabled This property is required. boolean - True if Point-in-time recovery is enabled.
- start
Time This property is required. string - HH:MM format time indicating when backup configuration starts.
- transaction
Log Retention Days 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[GetDatabase Instance Setting Backup Configuration Backup Retention Setting] - 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.)
- backup
Retention Settings This property is required. List<Property Map> - binary
Log Enabled 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.
- point
In Time Recovery Enabled This property is required. Boolean - True if Point-in-time recovery is enabled.
- start
Time This property is required. String - HH:MM format time indicating when backup configuration starts.
- transaction
Log Retention Days 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
- Retained
Backups This property is required. int - Number of backups to retain.
- Retention
Unit 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. string - The unit that 'retainedBackups' represents. Defaults to COUNT
- retained
Backups This property is required. Integer - Number of backups to retain.
- retention
Unit This property is required. String - The unit that 'retainedBackups' represents. Defaults to COUNT
- retained
Backups This property is required. number - Number of backups to retain.
- retention
Unit 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
- retained
Backups This property is required. Number - Number of backups to retain.
- retention
Unit This property is required. String - The unit that 'retainedBackups' represents. Defaults to COUNT
GetDatabaseInstanceSettingDataCacheConfig
- Data
Cache Enabled This property is required. bool - Whether data cache is enabled for the instance.
- Data
Cache Enabled This property is required. bool - Whether data cache is enabled for the instance.
- data
Cache Enabled This property is required. Boolean - Whether data cache is enabled for the instance.
- data
Cache Enabled 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.
- data
Cache Enabled This property is required. Boolean - Whether data cache is enabled for the instance.
GetDatabaseInstanceSettingDatabaseFlag
GetDatabaseInstanceSettingDenyMaintenancePeriod
- End
Date 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
- Start
Date 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. 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
- Start
Date 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. 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
- start
Date 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. 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
- start
Date 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
- end
Date 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
- start
Date 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
- 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.
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.
- 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.
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.
- query
Insights Enabled This property is required. Boolean - True if Query Insights feature is enabled.
- query
Plans Per Minute 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.
- query
String Length 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.
This property is required. Boolean- True if Query Insights will record application tags from query when enabled.
- record
Client Address This property is required. Boolean - True if Query Insights will record client address when enabled.
- query
Insights Enabled This property is required. boolean - True if Query Insights feature is enabled.
- query
Plans Per Minute 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.
- query
String Length 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.
This property is required. boolean- True if Query Insights will record application tags from query when enabled.
- record
Client Address 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.
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.
- query
Insights Enabled This property is required. Boolean - True if Query Insights feature is enabled.
- query
Plans Per Minute 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.
- query
String Length 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.
This property is required. Boolean- True if Query Insights will record application tags from query when enabled.
- record
Client Address This property is required. Boolean - True if Query Insights will record client address when enabled.
GetDatabaseInstanceSettingIpConfiguration
- Allocated
Ip Range 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?.
This property is required. List<GetDatabase Instance Setting Ip Configuration Authorized Network> - 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.
- 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.
- Private
Network 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.
- Psc
Configs This property is required. List<GetDatabase Instance Setting Ip Configuration Psc Config> - PSC settings for a Cloud SQL instance.
- Server
Ca Mode This property is required. string - Specify how the server certificate's Certificate Authority is hosted.
- Server
Ca Pool 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".
- Ssl
Mode This property is required. string - Specify how SSL connection should be enforced in DB connections.
- Allocated
Ip Range 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?.
This property is required. []GetDatabase Instance Setting Ip Configuration Authorized Network - 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.
- 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.
- Private
Network 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.
- Psc
Configs This property is required. []GetDatabase Instance Setting Ip Configuration Psc Config - PSC settings for a Cloud SQL instance.
- Server
Ca Mode This property is required. string - Specify how the server certificate's Certificate Authority is hosted.
- Server
Ca Pool 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".
- Ssl
Mode This property is required. string - Specify how SSL connection should be enforced in DB connections.
- allocated
Ip Range 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?.
This property is required. List<GetDatabase Instance Setting Ip Configuration Authorized Network> - enable
Private Path For Google Cloud Services 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.
- private
Network 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.
- psc
Configs This property is required. List<GetDatabase Instance Setting Ip Configuration Psc Config> - PSC settings for a Cloud SQL instance.
- server
Ca Mode This property is required. String - Specify how the server certificate's Certificate Authority is hosted.
- server
Ca Pool 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".
- ssl
Mode This property is required. String - Specify how SSL connection should be enforced in DB connections.
- allocated
Ip Range 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?.
This property is required. GetDatabase Instance Setting Ip Configuration Authorized Network[] - enable
Private Path For Google Cloud Services 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.
- private
Network 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.
- psc
Configs This property is required. GetDatabase Instance Setting Ip Configuration Psc Config[] - PSC settings for a Cloud SQL instance.
- server
Ca Mode This property is required. string - Specify how the server certificate's Certificate Authority is hosted.
- server
Ca Pool 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".
- ssl
Mode 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?.
This property is required. Sequence[GetDatabase Instance Setting Ip Configuration Authorized Network] - 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[GetDatabase Instance Setting Ip Configuration Psc Config] - 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.
- allocated
Ip Range 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?.
This property is required. List<Property Map>- enable
Private Path For Google Cloud Services 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.
- private
Network 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.
- psc
Configs This property is required. List<Property Map> - PSC settings for a Cloud SQL instance.
- server
Ca Mode This property is required. String - Specify how the server certificate's Certificate Authority is hosted.
- server
Ca Pool 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".
- ssl
Mode This property is required. String - Specify how SSL connection should be enforced in DB connections.
GetDatabaseInstanceSettingIpConfigurationAuthorizedNetwork
- Expiration
Time 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. string - Name
This property is required. string - The name of the instance.
- Value
This property is required. string
- expiration
Time 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. 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
- expiration
Time This property is required. String - name
This property is required. String - The name of the instance.
- value
This property is required. String
GetDatabaseInstanceSettingIpConfigurationPscConfig
- Allowed
Consumer Projects 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).
- Psc
Auto Connections This property is required. List<GetDatabase Instance Setting Ip Configuration Psc Config Psc Auto Connection> - 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.
- Allowed
Consumer Projects 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).
- Psc
Auto Connections This property is required. []GetDatabase Instance Setting Ip Configuration Psc Config Psc Auto Connection - 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.
- allowed
Consumer Projects 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).
- psc
Auto Connections This property is required. List<GetDatabase Instance Setting Ip Configuration Psc Config Psc Auto Connection> - 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. Boolean - Whether PSC connectivity is enabled for this instance.
- allowed
Consumer Projects 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).
- psc
Auto Connections This property is required. GetDatabase Instance Setting Ip Configuration Psc Config Psc Auto Connection[] - 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. 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[GetDatabase Instance Setting Ip Configuration Psc Config Psc Auto Connection] - 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.
- allowed
Consumer Projects 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).
- psc
Auto Connections 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.
- psc
Enabled This property is required. Boolean - Whether PSC connectivity is enabled for this instance.
GetDatabaseInstanceSettingIpConfigurationPscConfigPscAutoConnection
- Consumer
Network 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.
- Consumer
Service Project Id This property is required. string - The project ID of consumer service project of this consumer endpoint.
- Consumer
Network 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.
- Consumer
Service Project Id This property is required. string - The project ID of consumer service project of this consumer endpoint.
- consumer
Network 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.
- consumer
Service Project Id This property is required. String - The project ID of consumer service project of this consumer endpoint.
- consumer
Network 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.
- consumer
Service Project Id 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.
- consumer
Network 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.
- consumer
Service Project Id This property is required. String - The project ID of consumer service project of this consumer endpoint.
GetDatabaseInstanceSettingLocationPreference
- Follow
Gae Application This property is required. string - 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. 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. string - 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. 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. String - 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. 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. string - 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. 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.
- follow
Gae Application This property is required. String - 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. 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
- Update
Track 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. 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
- update
Track 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
- update
Track 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
- update
Track 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.
- 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. string - 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.
- 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. string - 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.
- disallow
Username Substring This property is required. Boolean - Disallow username as a part of the password.
- enable
Password Policy This property is required. Boolean - Whether the password policy is enabled or not.
- min
Length This property is required. Integer - Minimum number of characters allowed.
- password
Change Interval This property is required. String - Minimum interval after which the password can be changed. This flag is only supported for PostgresSQL.
- reuse
Interval This property is required. Integer - Number of previous passwords that cannot be reused.
- complexity
This property is required. string - Password complexity.
- disallow
Username Substring This property is required. boolean - Disallow username as a part of the password.
- enable
Password Policy This property is required. boolean - Whether the password policy is enabled or not.
- min
Length This property is required. number - Minimum number of characters allowed.
- password
Change Interval This property is required. string - Minimum interval after which the password can be changed. This flag is only supported for PostgresSQL.
- reuse
Interval 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.
- disallow
Username Substring This property is required. Boolean - Disallow username as a part of the password.
- enable
Password Policy This property is required. Boolean - Whether the password policy is enabled or not.
- min
Length This property is required. Number - Minimum number of characters allowed.
- password
Change Interval This property is required. String - Minimum interval after which the password can be changed. This flag is only supported for PostgresSQL.
- reuse
Interval 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).
- Retention
Interval 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"..
- Upload
Interval 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).
- Retention
Interval 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"..
- Upload
Interval 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).
- retention
Interval 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"..
- upload
Interval 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).
- retention
Interval 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"..
- upload
Interval 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).
- retention
Interval 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"..
- upload
Interval 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.