Google Cloud Classic v8.4.1 published on Tuesday, Oct 1, 2024 by Pulumi
gcp.sql.getDatabaseInstances
Explore with Pulumi AI
Use this data source to get information about a list of Cloud SQL instances in a project. You can also apply some filters over this list to get a more filtered list of Cloud SQL instances.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const qa = gcp.sql.getDatabaseInstances({
project: "test-project",
});
import pulumi
import pulumi_gcp as gcp
qa = gcp.sql.get_database_instances(project="test-project")
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.GetDatabaseInstances(ctx, &sql.GetDatabaseInstancesArgs{
Project: pulumi.StringRef("test-project"),
}, 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.GetDatabaseInstances.Invoke(new()
{
Project = "test-project",
});
});
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.GetDatabaseInstancesArgs;
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.getDatabaseInstances(GetDatabaseInstancesArgs.builder()
.project("test-project")
.build());
}
}
variables:
qa:
fn::invoke:
Function: gcp:sql:getDatabaseInstances
Arguments:
project: test-project
Using getDatabaseInstances
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 getDatabaseInstances(args: GetDatabaseInstancesArgs, opts?: InvokeOptions): Promise<GetDatabaseInstancesResult>
function getDatabaseInstancesOutput(args: GetDatabaseInstancesOutputArgs, opts?: InvokeOptions): Output<GetDatabaseInstancesResult>
def get_database_instances(database_version: Optional[str] = None,
project: Optional[str] = None,
region: Optional[str] = None,
state: Optional[str] = None,
tier: Optional[str] = None,
zone: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetDatabaseInstancesResult
def get_database_instances_output(database_version: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
region: Optional[pulumi.Input[str]] = None,
state: Optional[pulumi.Input[str]] = None,
tier: Optional[pulumi.Input[str]] = None,
zone: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseInstancesResult]
func GetDatabaseInstances(ctx *Context, args *GetDatabaseInstancesArgs, opts ...InvokeOption) (*GetDatabaseInstancesResult, error)
func GetDatabaseInstancesOutput(ctx *Context, args *GetDatabaseInstancesOutputArgs, opts ...InvokeOption) GetDatabaseInstancesResultOutput
> Note: This function is named GetDatabaseInstances
in the Go SDK.
public static class GetDatabaseInstances
{
public static Task<GetDatabaseInstancesResult> InvokeAsync(GetDatabaseInstancesArgs args, InvokeOptions? opts = null)
public static Output<GetDatabaseInstancesResult> Invoke(GetDatabaseInstancesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDatabaseInstancesResult> getDatabaseInstances(GetDatabaseInstancesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: gcp:sql/getDatabaseInstances:getDatabaseInstances
arguments:
# arguments dictionary
The following arguments are supported:
- Database
Version string - To filter out the Cloud SQL instances which are of the specified database version.
- Project string
- The ID of the project in which the resources belong. If it is not provided, the provider project is used.
- Region string
- To filter out the Cloud SQL instances which are located in the specified region.
- State string
- To filter out the Cloud SQL instances based on the current serving state of the database instance. Supported values include
SQL_INSTANCE_STATE_UNSPECIFIED
,RUNNABLE
,SUSPENDED
,PENDING_DELETE
,PENDING_CREATE
,MAINTENANCE
,FAILED
. - Tier string
- To filter out the Cloud SQL instances based on the tier(or machine type) of the database instances.
- Zone string
- To filter out the Cloud SQL instances which are located in the specified zone. This zone refers to the Compute Engine zone that the instance is currently serving from.
- Database
Version string - To filter out the Cloud SQL instances which are of the specified database version.
- Project string
- The ID of the project in which the resources belong. If it is not provided, the provider project is used.
- Region string
- To filter out the Cloud SQL instances which are located in the specified region.
- State string
- To filter out the Cloud SQL instances based on the current serving state of the database instance. Supported values include
SQL_INSTANCE_STATE_UNSPECIFIED
,RUNNABLE
,SUSPENDED
,PENDING_DELETE
,PENDING_CREATE
,MAINTENANCE
,FAILED
. - Tier string
- To filter out the Cloud SQL instances based on the tier(or machine type) of the database instances.
- Zone string
- To filter out the Cloud SQL instances which are located in the specified zone. This zone refers to the Compute Engine zone that the instance is currently serving from.
- database
Version String - To filter out the Cloud SQL instances which are of the specified database version.
- project String
- The ID of the project in which the resources belong. If it is not provided, the provider project is used.
- region String
- To filter out the Cloud SQL instances which are located in the specified region.
- state String
- To filter out the Cloud SQL instances based on the current serving state of the database instance. Supported values include
SQL_INSTANCE_STATE_UNSPECIFIED
,RUNNABLE
,SUSPENDED
,PENDING_DELETE
,PENDING_CREATE
,MAINTENANCE
,FAILED
. - tier String
- To filter out the Cloud SQL instances based on the tier(or machine type) of the database instances.
- zone String
- To filter out the Cloud SQL instances which are located in the specified zone. This zone refers to the Compute Engine zone that the instance is currently serving from.
- database
Version string - To filter out the Cloud SQL instances which are of the specified database version.
- project string
- The ID of the project in which the resources belong. If it is not provided, the provider project is used.
- region string
- To filter out the Cloud SQL instances which are located in the specified region.
- state string
- To filter out the Cloud SQL instances based on the current serving state of the database instance. Supported values include
SQL_INSTANCE_STATE_UNSPECIFIED
,RUNNABLE
,SUSPENDED
,PENDING_DELETE
,PENDING_CREATE
,MAINTENANCE
,FAILED
. - tier string
- To filter out the Cloud SQL instances based on the tier(or machine type) of the database instances.
- zone string
- To filter out the Cloud SQL instances which are located in the specified zone. This zone refers to the Compute Engine zone that the instance is currently serving from.
- database_
version str - To filter out the Cloud SQL instances which are of the specified database version.
- project str
- The ID of the project in which the resources belong. If it is not provided, the provider project is used.
- region str
- To filter out the Cloud SQL instances which are located in the specified region.
- state str
- To filter out the Cloud SQL instances based on the current serving state of the database instance. Supported values include
SQL_INSTANCE_STATE_UNSPECIFIED
,RUNNABLE
,SUSPENDED
,PENDING_DELETE
,PENDING_CREATE
,MAINTENANCE
,FAILED
. - tier str
- To filter out the Cloud SQL instances based on the tier(or machine type) of the database instances.
- zone str
- To filter out the Cloud SQL instances which are located in the specified zone. This zone refers to the Compute Engine zone that the instance is currently serving from.
- database
Version String - To filter out the Cloud SQL instances which are of the specified database version.
- project String
- The ID of the project in which the resources belong. If it is not provided, the provider project is used.
- region String
- To filter out the Cloud SQL instances which are located in the specified region.
- state String
- To filter out the Cloud SQL instances based on the current serving state of the database instance. Supported values include
SQL_INSTANCE_STATE_UNSPECIFIED
,RUNNABLE
,SUSPENDED
,PENDING_DELETE
,PENDING_CREATE
,MAINTENANCE
,FAILED
. - tier String
- To filter out the Cloud SQL instances based on the tier(or machine type) of the database instances.
- zone String
- To filter out the Cloud SQL instances which are located in the specified zone. This zone refers to the Compute Engine zone that the instance is currently serving from.
getDatabaseInstances Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Instances
List<Get
Database Instances Instance> - Database
Version string - Project string
- Region string
- State string
- Tier string
- Zone string
- Id string
- The provider-assigned unique ID for this managed resource.
- Instances
[]Get
Database Instances Instance - Database
Version string - Project string
- Region string
- State string
- Tier string
- Zone string
- id String
- The provider-assigned unique ID for this managed resource.
- instances
List<Get
Database Instances Instance> - database
Version String - project String
- region String
- state String
- tier String
- zone String
- id string
- The provider-assigned unique ID for this managed resource.
- instances
Get
Database Instances Instance[] - database
Version string - project string
- region string
- state string
- tier string
- zone string
- id str
- The provider-assigned unique ID for this managed resource.
- instances
Sequence[Get
Database Instances Instance] - database_
version str - project str
- region str
- state str
- tier str
- zone str
- id String
- The provider-assigned unique ID for this managed resource.
- instances List<Property Map>
- database
Version String - project String
- region String
- state String
- tier String
- zone String
Supporting Types
GetDatabaseInstancesInstance
- Available
Maintenance List<string>Versions - Available Maintenance versions.
- Clones
List<Get
Database Instances Instance Clone> - Configuration for creating a new instance as a clone of another instance.
- Connection
Name string - The connection name of the instance to be used in connection strings. For example, when connecting with Cloud SQL Proxy.
- Database
Version string - To filter out the Cloud SQL instances which are of the specified database version.
- Deletion
Protection bool - Dns
Name string - The dns name of the instance.
- Encryption
Key stringName - First
Ip stringAddress - Instance
Type string - The type of the instance. The valid values are:- 'SQL_INSTANCE_TYPE_UNSPECIFIED', 'CLOUD_SQL_INSTANCE', 'ON_PREMISES_INSTANCE' and 'READ_REPLICA_INSTANCE'.
- Ip
Addresses List<GetDatabase Instances Instance Ip Address> - Maintenance
Version string - Maintenance version.
- Master
Instance stringName - The name of the instance that will act as the master in the replication setup. Note, this requires the master to have binary_log_enabled set, as well as existing backups.
- Name string
- Private
Ip stringAddress - Project string
- The ID of the project in which the resources belong. If it is not provided, the provider project is used.
- Psc
Service stringAttachment Link - The link to service attachment of PSC instance.
- Public
Ip stringAddress - Region string
- To filter out the Cloud SQL instances which are located in the specified region.
- Replica
Configurations List<GetDatabase Instances Instance Replica Configuration> - The configuration for replication.
- Restore
Backup List<GetContexts Database Instances Instance Restore Backup Context> - Root
Password string - Initial root password. Required for MS SQL Server.
- Self
Link string - The URI of the created resource.
- Server
Ca List<GetCerts Database Instances Instance Server Ca Cert> - Service
Account stringEmail Address - The service account email address assigned to the instance.
- Settings
List<Get
Database Instances Instance Setting> - The settings to use for the database. The configuration is detailed below.
- Available
Maintenance []stringVersions - Available Maintenance versions.
- Clones
[]Get
Database Instances Instance Clone - Configuration for creating a new instance as a clone of another instance.
- Connection
Name string - The connection name of the instance to be used in connection strings. For example, when connecting with Cloud SQL Proxy.
- Database
Version string - To filter out the Cloud SQL instances which are of the specified database version.
- Deletion
Protection bool - Dns
Name string - The dns name of the instance.
- Encryption
Key stringName - First
Ip stringAddress - Instance
Type string - The type of the instance. The valid values are:- 'SQL_INSTANCE_TYPE_UNSPECIFIED', 'CLOUD_SQL_INSTANCE', 'ON_PREMISES_INSTANCE' and 'READ_REPLICA_INSTANCE'.
- Ip
Addresses []GetDatabase Instances Instance Ip Address - Maintenance
Version string - Maintenance version.
- Master
Instance stringName - The name of the instance that will act as the master in the replication setup. Note, this requires the master to have binary_log_enabled set, as well as existing backups.
- Name string
- Private
Ip stringAddress - Project string
- The ID of the project in which the resources belong. If it is not provided, the provider project is used.
- Psc
Service stringAttachment Link - The link to service attachment of PSC instance.
- Public
Ip stringAddress - Region string
- To filter out the Cloud SQL instances which are located in the specified region.
- Replica
Configurations []GetDatabase Instances Instance Replica Configuration - The configuration for replication.
- Restore
Backup []GetContexts Database Instances Instance Restore Backup Context - Root
Password string - Initial root password. Required for MS SQL Server.
- Self
Link string - The URI of the created resource.
- Server
Ca []GetCerts Database Instances Instance Server Ca Cert - Service
Account stringEmail Address - The service account email address assigned to the instance.
- Settings
[]Get
Database Instances Instance Setting - The settings to use for the database. The configuration is detailed below.
- available
Maintenance List<String>Versions - Available Maintenance versions.
- clones
List<Get
Database Instances Instance Clone> - Configuration for creating a new instance as a clone of another instance.
- connection
Name String - The connection name of the instance to be used in connection strings. For example, when connecting with Cloud SQL Proxy.
- database
Version String - To filter out the Cloud SQL instances which are of the specified database version.
- deletion
Protection Boolean - dns
Name String - The dns name of the instance.
- encryption
Key StringName - first
Ip StringAddress - instance
Type String - The type of the instance. The valid values are:- 'SQL_INSTANCE_TYPE_UNSPECIFIED', 'CLOUD_SQL_INSTANCE', 'ON_PREMISES_INSTANCE' and 'READ_REPLICA_INSTANCE'.
- ip
Addresses List<GetDatabase Instances Instance Ip Address> - maintenance
Version String - Maintenance version.
- master
Instance StringName - The name of the instance that will act as the master in the replication setup. Note, this requires the master to have binary_log_enabled set, as well as existing backups.
- name String
- private
Ip StringAddress - project String
- The ID of the project in which the resources belong. If it is not provided, the provider project is used.
- psc
Service StringAttachment Link - The link to service attachment of PSC instance.
- public
Ip StringAddress - region String
- To filter out the Cloud SQL instances which are located in the specified region.
- replica
Configurations List<GetDatabase Instances Instance Replica Configuration> - The configuration for replication.
- restore
Backup List<GetContexts Database Instances Instance Restore Backup Context> - root
Password String - Initial root password. Required for MS SQL Server.
- self
Link String - The URI of the created resource.
- server
Ca List<GetCerts Database Instances Instance Server Ca Cert> - service
Account StringEmail Address - The service account email address assigned to the instance.
- settings
List<Get
Database Instances Instance Setting> - The settings to use for the database. The configuration is detailed below.
- available
Maintenance string[]Versions - Available Maintenance versions.
- clones
Get
Database Instances Instance Clone[] - Configuration for creating a new instance as a clone of another instance.
- connection
Name string - The connection name of the instance to be used in connection strings. For example, when connecting with Cloud SQL Proxy.
- database
Version string - To filter out the Cloud SQL instances which are of the specified database version.
- deletion
Protection boolean - dns
Name string - The dns name of the instance.
- encryption
Key stringName - first
Ip stringAddress - instance
Type string - The type of the instance. The valid values are:- 'SQL_INSTANCE_TYPE_UNSPECIFIED', 'CLOUD_SQL_INSTANCE', 'ON_PREMISES_INSTANCE' and 'READ_REPLICA_INSTANCE'.
- ip
Addresses GetDatabase Instances Instance Ip Address[] - maintenance
Version string - Maintenance version.
- master
Instance stringName - The name of the instance that will act as the master in the replication setup. Note, this requires the master to have binary_log_enabled set, as well as existing backups.
- name string
- private
Ip stringAddress - project string
- The ID of the project in which the resources belong. If it is not provided, the provider project is used.
- psc
Service stringAttachment Link - The link to service attachment of PSC instance.
- public
Ip stringAddress - region string
- To filter out the Cloud SQL instances which are located in the specified region.
- replica
Configurations GetDatabase Instances Instance Replica Configuration[] - The configuration for replication.
- restore
Backup GetContexts Database Instances Instance Restore Backup Context[] - root
Password string - Initial root password. Required for MS SQL Server.
- self
Link string - The URI of the created resource.
- server
Ca GetCerts Database Instances Instance Server Ca Cert[] - service
Account stringEmail Address - The service account email address assigned to the instance.
- settings
Get
Database Instances Instance Setting[] - The settings to use for the database. The configuration is detailed below.
- available_
maintenance_ Sequence[str]versions - Available Maintenance versions.
- clones
Sequence[Get
Database Instances Instance Clone] - Configuration for creating a new instance as a clone of another instance.
- connection_
name str - The connection name of the instance to be used in connection strings. For example, when connecting with Cloud SQL Proxy.
- database_
version str - To filter out the Cloud SQL instances which are of the specified database version.
- deletion_
protection bool - dns_
name str - The dns name of the instance.
- encryption_
key_ strname - first_
ip_ straddress - instance_
type str - The type of the instance. The valid values are:- 'SQL_INSTANCE_TYPE_UNSPECIFIED', 'CLOUD_SQL_INSTANCE', 'ON_PREMISES_INSTANCE' and 'READ_REPLICA_INSTANCE'.
- ip_
addresses Sequence[GetDatabase Instances Instance Ip Address] - maintenance_
version str - Maintenance version.
- master_
instance_ strname - The name of the instance that will act as the master in the replication setup. Note, this requires the master to have binary_log_enabled set, as well as existing backups.
- name str
- private_
ip_ straddress - project str
- The ID of the project in which the resources belong. If it is not provided, the provider project is used.
- psc_
service_ strattachment_ link - The link to service attachment of PSC instance.
- public_
ip_ straddress - region str
- To filter out the Cloud SQL instances which are located in the specified region.
- replica_
configurations Sequence[GetDatabase Instances Instance Replica Configuration] - The configuration for replication.
- restore_
backup_ Sequence[Getcontexts Database Instances Instance Restore Backup Context] - root_
password str - Initial root password. Required for MS SQL Server.
- self_
link str - The URI of the created resource.
- server_
ca_ Sequence[Getcerts Database Instances Instance Server Ca Cert] - service_
account_ stremail_ address - The service account email address assigned to the instance.
- settings
Sequence[Get
Database Instances Instance Setting] - The settings to use for the database. The configuration is detailed below.
- available
Maintenance List<String>Versions - Available Maintenance versions.
- clones List<Property Map>
- Configuration for creating a new instance as a clone of another instance.
- connection
Name String - The connection name of the instance to be used in connection strings. For example, when connecting with Cloud SQL Proxy.
- database
Version String - To filter out the Cloud SQL instances which are of the specified database version.
- deletion
Protection Boolean - dns
Name String - The dns name of the instance.
- encryption
Key StringName - first
Ip StringAddress - instance
Type String - The type of the instance. The valid values are:- 'SQL_INSTANCE_TYPE_UNSPECIFIED', 'CLOUD_SQL_INSTANCE', 'ON_PREMISES_INSTANCE' and 'READ_REPLICA_INSTANCE'.
- ip
Addresses List<Property Map> - maintenance
Version String - Maintenance version.
- master
Instance StringName - The name of the instance that will act as the master in the replication setup. Note, this requires the master to have binary_log_enabled set, as well as existing backups.
- name String
- private
Ip StringAddress - project String
- The ID of the project in which the resources belong. If it is not provided, the provider project is used.
- psc
Service StringAttachment Link - The link to service attachment of PSC instance.
- public
Ip StringAddress - region String
- To filter out the Cloud SQL instances which are located in the specified region.
- replica
Configurations List<Property Map> - The configuration for replication.
- restore
Backup List<Property Map>Contexts - root
Password String - Initial root password. Required for MS SQL Server.
- self
Link String - The URI of the created resource.
- server
Ca List<Property Map>Certs - service
Account StringEmail Address - The service account email address assigned to the instance.
- settings List<Property Map>
- The settings to use for the database. The configuration is detailed below.
GetDatabaseInstancesInstanceClone
- Allocated
Ip stringRange - 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 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 stringTime - The timestamp of the point in time that should be restored.
- Preferred
Zone 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 stringName - The name of the instance from which the point in time should be restored.
- Allocated
Ip stringRange - 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 []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 stringTime - The timestamp of the point in time that should be restored.
- Preferred
Zone 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 stringName - The name of the instance from which the point in time should be restored.
- allocated
Ip StringRange - 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 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 StringTime - The timestamp of the point in time that should be restored.
- preferred
Zone 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 StringName - The name of the instance from which the point in time should be restored.
- allocated
Ip stringRange - 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 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 stringTime - The timestamp of the point in time that should be restored.
- preferred
Zone 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 stringName - The name of the instance from which the point in time should be restored.
- allocated_
ip_ strrange - 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 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_ strtime - The timestamp of the point in time that should be restored.
- preferred_
zone 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_ strname - The name of the instance from which the point in time should be restored.
- allocated
Ip StringRange - 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 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 StringTime - The timestamp of the point in time that should be restored.
- preferred
Zone 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 StringName - The name of the instance from which the point in time should be restored.
GetDatabaseInstancesInstanceIpAddress
- Ip
Address string - Time
To stringRetire - Type string
- Ip
Address string - Time
To stringRetire - Type string
- ip
Address String - time
To StringRetire - type String
- ip
Address string - time
To stringRetire - type string
- ip_
address str - time_
to_ strretire - type str
- ip
Address String - time
To StringRetire - type String
GetDatabaseInstancesInstanceReplicaConfiguration
- Ca
Certificate string - PEM representation of the trusted CA's x509 certificate.
- Client
Certificate string - PEM representation of the replica's x509 certificate.
- Client
Key string - PEM representation of the replica's private key. The corresponding public key in encoded in the client_certificate.
- Connect
Retry intInterval - The number of seconds between connect retries. MySQL's default is 60 seconds.
- Dump
File stringPath - Path to a SQL file in Google Cloud Storage from which replica instances are created. Format is gs://bucket/filename.
- Failover
Target 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 intPeriod - Time in ms between replication heartbeats.
- Password string
- Password for the replication connection.
- Ssl
Cipher string - Permissible ciphers for use in SSL encryption.
- Username string
- Username for replication connection.
- Verify
Server boolCertificate - True if the master's common name value is checked during the SSL handshake.
- Ca
Certificate string - PEM representation of the trusted CA's x509 certificate.
- Client
Certificate string - PEM representation of the replica's x509 certificate.
- Client
Key string - PEM representation of the replica's private key. The corresponding public key in encoded in the client_certificate.
- Connect
Retry intInterval - The number of seconds between connect retries. MySQL's default is 60 seconds.
- Dump
File stringPath - Path to a SQL file in Google Cloud Storage from which replica instances are created. Format is gs://bucket/filename.
- Failover
Target 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 intPeriod - Time in ms between replication heartbeats.
- Password string
- Password for the replication connection.
- Ssl
Cipher string - Permissible ciphers for use in SSL encryption.
- Username string
- Username for replication connection.
- Verify
Server boolCertificate - True if the master's common name value is checked during the SSL handshake.
- ca
Certificate String - PEM representation of the trusted CA's x509 certificate.
- client
Certificate String - PEM representation of the replica's x509 certificate.
- client
Key String - PEM representation of the replica's private key. The corresponding public key in encoded in the client_certificate.
- connect
Retry IntegerInterval - The number of seconds between connect retries. MySQL's default is 60 seconds.
- dump
File StringPath - Path to a SQL file in Google Cloud Storage from which replica instances are created. Format is gs://bucket/filename.
- failover
Target 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 IntegerPeriod - Time in ms between replication heartbeats.
- password String
- Password for the replication connection.
- ssl
Cipher String - Permissible ciphers for use in SSL encryption.
- username String
- Username for replication connection.
- verify
Server BooleanCertificate - True if the master's common name value is checked during the SSL handshake.
- ca
Certificate string - PEM representation of the trusted CA's x509 certificate.
- client
Certificate string - PEM representation of the replica's x509 certificate.
- client
Key string - PEM representation of the replica's private key. The corresponding public key in encoded in the client_certificate.
- connect
Retry numberInterval - The number of seconds between connect retries. MySQL's default is 60 seconds.
- dump
File stringPath - Path to a SQL file in Google Cloud Storage from which replica instances are created. Format is gs://bucket/filename.
- failover
Target 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 numberPeriod - Time in ms between replication heartbeats.
- password string
- Password for the replication connection.
- ssl
Cipher string - Permissible ciphers for use in SSL encryption.
- username string
- Username for replication connection.
- verify
Server booleanCertificate - True if the master's common name value is checked during the SSL handshake.
- ca_
certificate str - PEM representation of the trusted CA's x509 certificate.
- client_
certificate str - PEM representation of the replica's x509 certificate.
- client_
key str - PEM representation of the replica's private key. The corresponding public key in encoded in the client_certificate.
- connect_
retry_ intinterval - The number of seconds between connect retries. MySQL's default is 60 seconds.
- dump_
file_ strpath - Path to a SQL file in Google Cloud Storage from which replica instances are created. Format is gs://bucket/filename.
- failover_
target 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_ intperiod - Time in ms between replication heartbeats.
- password str
- Password for the replication connection.
- ssl_
cipher str - Permissible ciphers for use in SSL encryption.
- username str
- Username for replication connection.
- verify_
server_ boolcertificate - True if the master's common name value is checked during the SSL handshake.
- ca
Certificate String - PEM representation of the trusted CA's x509 certificate.
- client
Certificate String - PEM representation of the replica's x509 certificate.
- client
Key String - PEM representation of the replica's private key. The corresponding public key in encoded in the client_certificate.
- connect
Retry NumberInterval - The number of seconds between connect retries. MySQL's default is 60 seconds.
- dump
File StringPath - Path to a SQL file in Google Cloud Storage from which replica instances are created. Format is gs://bucket/filename.
- failover
Target 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 NumberPeriod - Time in ms between replication heartbeats.
- password String
- Password for the replication connection.
- ssl
Cipher String - Permissible ciphers for use in SSL encryption.
- username String
- Username for replication connection.
- verify
Server BooleanCertificate - True if the master's common name value is checked during the SSL handshake.
GetDatabaseInstancesInstanceRestoreBackupContext
- Backup
Run intId - The ID of the backup run to restore from.
- Instance
Id string - The ID of the instance that the backup was taken from.
- Project string
- The ID of the project in which the resources belong. If it is not provided, the provider project is used.
- Backup
Run intId - The ID of the backup run to restore from.
- Instance
Id string - The ID of the instance that the backup was taken from.
- Project string
- The ID of the project in which the resources belong. If it is not provided, the provider project is used.
- backup
Run IntegerId - The ID of the backup run to restore from.
- instance
Id String - The ID of the instance that the backup was taken from.
- project String
- The ID of the project in which the resources belong. If it is not provided, the provider project is used.
- backup
Run numberId - The ID of the backup run to restore from.
- instance
Id string - The ID of the instance that the backup was taken from.
- project string
- The ID of the project in which the resources belong. If it is not provided, the provider project is used.
- backup_
run_ intid - The ID of the backup run to restore from.
- instance_
id str - The ID of the instance that the backup was taken from.
- project str
- The ID of the project in which the resources belong. If it is not provided, the provider project is used.
- backup
Run NumberId - The ID of the backup run to restore from.
- instance
Id String - The ID of the instance that the backup was taken from.
- project String
- The ID of the project in which the resources belong. If it is not provided, the provider project is used.
GetDatabaseInstancesInstanceServerCaCert
- Cert string
- The CA Certificate used to connect to the SQL Instance via SSL.
- Common
Name string - The CN valid for the CA Cert.
- Create
Time string - Creation time of the CA Cert.
- Expiration
Time string - Expiration time of the CA Cert.
- Sha1Fingerprint string
- SHA Fingerprint of the CA Cert.
- Cert string
- The CA Certificate used to connect to the SQL Instance via SSL.
- Common
Name string - The CN valid for the CA Cert.
- Create
Time string - Creation time of the CA Cert.
- Expiration
Time string - Expiration time of the CA Cert.
- Sha1Fingerprint string
- SHA Fingerprint of the CA Cert.
- cert String
- The CA Certificate used to connect to the SQL Instance via SSL.
- common
Name String - The CN valid for the CA Cert.
- create
Time String - Creation time of the CA Cert.
- expiration
Time String - Expiration time of the CA Cert.
- sha1Fingerprint String
- SHA Fingerprint of the CA Cert.
- cert string
- The CA Certificate used to connect to the SQL Instance via SSL.
- common
Name string - The CN valid for the CA Cert.
- create
Time string - Creation time of the CA Cert.
- expiration
Time string - Expiration time of the CA Cert.
- sha1Fingerprint string
- SHA Fingerprint of the CA Cert.
- cert str
- The CA Certificate used to connect to the SQL Instance via SSL.
- common_
name str - The CN valid for the CA Cert.
- create_
time str - Creation time of the CA Cert.
- expiration_
time str - Expiration time of the CA Cert.
- sha1_
fingerprint str - SHA Fingerprint of the CA Cert.
- cert String
- The CA Certificate used to connect to the SQL Instance via SSL.
- common
Name String - The CN valid for the CA Cert.
- create
Time String - Creation time of the CA Cert.
- expiration
Time String - Expiration time of the CA Cert.
- sha1Fingerprint String
- SHA Fingerprint of the CA Cert.
GetDatabaseInstancesInstanceSetting
- Activation
Policy string - This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND.
- Active
Directory List<GetConfigs Database Instances Instance Setting Active Directory Config> - Advanced
Machine List<GetFeatures Database Instances Instance Setting Advanced Machine Feature> - Availability
Type 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 List<GetDatabase Instances Instance Setting Backup Configuration> - Collation string
- The name of server instance collation.
- Connector
Enforcement 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 List<GetConfigs Database Instances Instance Setting Data Cache Config> - Data cache configurations.
- Database
Flags List<GetDatabase Instances Instance Setting Database Flag> - Deletion
Protection boolEnabled - Configuration to protect against accidental instance deletion.
- Deny
Maintenance List<GetPeriods Database Instances Instance Setting Deny Maintenance Period> - Disk
Autoresize bool - Enables auto-resizing of the storage size. Defaults to true.
- Disk
Autoresize intLimit - 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 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 string - The type of data disk: PD_SSD or PD_HDD. Defaults to PD_SSD.
- Edition string
- The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS.
- Enable
Dataplex boolIntegration - Enables Dataplex Integration.
- Enable
Google boolMl Integration - Enables Vertex AI Integration.
- Insights
Configs List<GetDatabase Instances Instance Setting Insights Config> - Configuration of Query Insights.
- Ip
Configurations List<GetDatabase Instances Instance Setting Ip Configuration> - Location
Preferences List<GetDatabase Instances Instance Setting Location Preference> - Maintenance
Windows List<GetDatabase Instances 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 List<GetPolicies Database Instances Instance Setting Password Validation Policy> - Pricing
Plan string - Pricing plan for this instance, can only be PER_USE.
- Sql
Server List<GetAudit Configs Database Instances Instance Setting Sql Server Audit Config> - Tier string
- To filter out the Cloud SQL instances based on the tier(or machine type) of the database instances.
- Time
Zone string - The time_zone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format.
- User
Labels Dictionary<string, string> - A set of key/value user label pairs to assign to the instance.
- Version int
- Used to make sure changes to the settings block are atomic.
- Activation
Policy string - This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND.
- Active
Directory []GetConfigs Database Instances Instance Setting Active Directory Config - Advanced
Machine []GetFeatures Database Instances Instance Setting Advanced Machine Feature - Availability
Type 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 []GetDatabase Instances Instance Setting Backup Configuration - Collation string
- The name of server instance collation.
- Connector
Enforcement 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 []GetConfigs Database Instances Instance Setting Data Cache Config - Data cache configurations.
- Database
Flags []GetDatabase Instances Instance Setting Database Flag - Deletion
Protection boolEnabled - Configuration to protect against accidental instance deletion.
- Deny
Maintenance []GetPeriods Database Instances Instance Setting Deny Maintenance Period - Disk
Autoresize bool - Enables auto-resizing of the storage size. Defaults to true.
- Disk
Autoresize intLimit - 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 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 string - The type of data disk: PD_SSD or PD_HDD. Defaults to PD_SSD.
- Edition string
- The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS.
- Enable
Dataplex boolIntegration - Enables Dataplex Integration.
- Enable
Google boolMl Integration - Enables Vertex AI Integration.
- Insights
Configs []GetDatabase Instances Instance Setting Insights Config - Configuration of Query Insights.
- Ip
Configurations []GetDatabase Instances Instance Setting Ip Configuration - Location
Preferences []GetDatabase Instances Instance Setting Location Preference - Maintenance
Windows []GetDatabase Instances 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 []GetPolicies Database Instances Instance Setting Password Validation Policy - Pricing
Plan string - Pricing plan for this instance, can only be PER_USE.
- Sql
Server []GetAudit Configs Database Instances Instance Setting Sql Server Audit Config - Tier string
- To filter out the Cloud SQL instances based on the tier(or machine type) of the database instances.
- Time
Zone string - The time_zone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format.
- User
Labels map[string]string - A set of key/value user label pairs to assign to the instance.
- Version int
- Used to make sure changes to the settings block are atomic.
- activation
Policy String - This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND.
- active
Directory List<GetConfigs Database Instances Instance Setting Active Directory Config> - advanced
Machine List<GetFeatures Database Instances Instance Setting Advanced Machine Feature> - availability
Type 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 List<GetDatabase Instances Instance Setting Backup Configuration> - collation String
- The name of server instance collation.
- connector
Enforcement 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 List<GetConfigs Database Instances Instance Setting Data Cache Config> - Data cache configurations.
- database
Flags List<GetDatabase Instances Instance Setting Database Flag> - deletion
Protection BooleanEnabled - Configuration to protect against accidental instance deletion.
- deny
Maintenance List<GetPeriods Database Instances Instance Setting Deny Maintenance Period> - disk
Autoresize Boolean - Enables auto-resizing of the storage size. Defaults to true.
- disk
Autoresize IntegerLimit - 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 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 String - The type of data disk: PD_SSD or PD_HDD. Defaults to PD_SSD.
- edition String
- The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS.
- enable
Dataplex BooleanIntegration - Enables Dataplex Integration.
- enable
Google BooleanMl Integration - Enables Vertex AI Integration.
- insights
Configs List<GetDatabase Instances Instance Setting Insights Config> - Configuration of Query Insights.
- ip
Configurations List<GetDatabase Instances Instance Setting Ip Configuration> - location
Preferences List<GetDatabase Instances Instance Setting Location Preference> - maintenance
Windows List<GetDatabase Instances 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 List<GetPolicies Database Instances Instance Setting Password Validation Policy> - pricing
Plan String - Pricing plan for this instance, can only be PER_USE.
- sql
Server List<GetAudit Configs Database Instances Instance Setting Sql Server Audit Config> - tier String
- To filter out the Cloud SQL instances based on the tier(or machine type) of the database instances.
- time
Zone String - The time_zone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format.
- user
Labels Map<String,String> - A set of key/value user label pairs to assign to the instance.
- version Integer
- Used to make sure changes to the settings block are atomic.
- activation
Policy string - This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND.
- active
Directory GetConfigs Database Instances Instance Setting Active Directory Config[] - advanced
Machine GetFeatures Database Instances Instance Setting Advanced Machine Feature[] - availability
Type 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 GetDatabase Instances Instance Setting Backup Configuration[] - collation string
- The name of server instance collation.
- connector
Enforcement 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 GetConfigs Database Instances Instance Setting Data Cache Config[] - Data cache configurations.
- database
Flags GetDatabase Instances Instance Setting Database Flag[] - deletion
Protection booleanEnabled - Configuration to protect against accidental instance deletion.
- deny
Maintenance GetPeriods Database Instances Instance Setting Deny Maintenance Period[] - disk
Autoresize boolean - Enables auto-resizing of the storage size. Defaults to true.
- disk
Autoresize numberLimit - 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 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 string - The type of data disk: PD_SSD or PD_HDD. Defaults to PD_SSD.
- edition string
- The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS.
- enable
Dataplex booleanIntegration - Enables Dataplex Integration.
- enable
Google booleanMl Integration - Enables Vertex AI Integration.
- insights
Configs GetDatabase Instances Instance Setting Insights Config[] - Configuration of Query Insights.
- ip
Configurations GetDatabase Instances Instance Setting Ip Configuration[] - location
Preferences GetDatabase Instances Instance Setting Location Preference[] - maintenance
Windows GetDatabase Instances 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 GetPolicies Database Instances Instance Setting Password Validation Policy[] - pricing
Plan string - Pricing plan for this instance, can only be PER_USE.
- sql
Server GetAudit Configs Database Instances Instance Setting Sql Server Audit Config[] - tier string
- To filter out the Cloud SQL instances based on the tier(or machine type) of the database instances.
- time
Zone string - The time_zone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format.
- user
Labels {[key: string]: string} - A set of key/value user label pairs to assign to the instance.
- version number
- Used to make sure changes to the settings block are atomic.
- activation_
policy str - This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND.
- active_
directory_ Sequence[Getconfigs Database Instances Instance Setting Active Directory Config] - advanced_
machine_ Sequence[Getfeatures Database Instances Instance Setting Advanced Machine Feature] - availability_
type 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 Sequence[GetDatabase Instances Instance Setting Backup Configuration] - collation str
- The name of server instance collation.
- connector_
enforcement 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_ Sequence[Getconfigs Database Instances Instance Setting Data Cache Config] - Data cache configurations.
- database_
flags Sequence[GetDatabase Instances Instance Setting Database Flag] - deletion_
protection_ boolenabled - Configuration to protect against accidental instance deletion.
- deny_
maintenance_ Sequence[Getperiods Database Instances Instance Setting Deny Maintenance Period] - disk_
autoresize bool - Enables auto-resizing of the storage size. Defaults to true.
- disk_
autoresize_ intlimit - 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 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 str - The type of data disk: PD_SSD or PD_HDD. Defaults to PD_SSD.
- edition str
- The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS.
- enable_
dataplex_ boolintegration - Enables Dataplex Integration.
- enable_
google_ boolml_ integration - Enables Vertex AI Integration.
- insights_
configs Sequence[GetDatabase Instances Instance Setting Insights Config] - Configuration of Query Insights.
- ip_
configurations Sequence[GetDatabase Instances Instance Setting Ip Configuration] - location_
preferences Sequence[GetDatabase Instances Instance Setting Location Preference] - maintenance_
windows Sequence[GetDatabase Instances 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_ Sequence[Getpolicies Database Instances Instance Setting Password Validation Policy] - pricing_
plan str - Pricing plan for this instance, can only be PER_USE.
- sql_
server_ Sequence[Getaudit_ configs Database Instances Instance Setting Sql Server Audit Config] - tier str
- To filter out the Cloud SQL instances based on the tier(or machine type) of the database instances.
- time_
zone str - The time_zone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format.
- user_
labels Mapping[str, str] - A set of key/value user label pairs to assign to the instance.
- version int
- Used to make sure changes to the settings block are atomic.
- activation
Policy String - This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND.
- active
Directory List<Property Map>Configs - advanced
Machine List<Property Map>Features - availability
Type 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 List<Property Map> - collation String
- The name of server instance collation.
- connector
Enforcement 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 List<Property Map>Configs - Data cache configurations.
- database
Flags List<Property Map> - deletion
Protection BooleanEnabled - Configuration to protect against accidental instance deletion.
- deny
Maintenance List<Property Map>Periods - disk
Autoresize Boolean - Enables auto-resizing of the storage size. Defaults to true.
- disk
Autoresize NumberLimit - 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 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 String - The type of data disk: PD_SSD or PD_HDD. Defaults to PD_SSD.
- edition String
- The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS.
- enable
Dataplex BooleanIntegration - Enables Dataplex Integration.
- enable
Google BooleanMl Integration - Enables Vertex AI Integration.
- insights
Configs List<Property Map> - Configuration of Query Insights.
- ip
Configurations List<Property Map> - location
Preferences List<Property Map> - maintenance
Windows 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 List<Property Map>Policies - pricing
Plan String - Pricing plan for this instance, can only be PER_USE.
- sql
Server List<Property Map>Audit Configs - tier String
- To filter out the Cloud SQL instances based on the tier(or machine type) of the database instances.
- time
Zone String - The time_zone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format.
- user
Labels Map<String> - A set of key/value user label pairs to assign to the instance.
- version Number
- Used to make sure changes to the settings block are atomic.
GetDatabaseInstancesInstanceSettingActiveDirectoryConfig
- Domain string
- Domain name of the Active Directory for SQL Server (e.g., mydomain.com).
- Domain string
- Domain name of the Active Directory for SQL Server (e.g., mydomain.com).
- domain String
- Domain name of the Active Directory for SQL Server (e.g., mydomain.com).
- domain string
- Domain name of the Active Directory for SQL Server (e.g., mydomain.com).
- domain str
- Domain name of the Active Directory for SQL Server (e.g., mydomain.com).
- domain String
- Domain name of the Active Directory for SQL Server (e.g., mydomain.com).
GetDatabaseInstancesInstanceSettingAdvancedMachineFeature
- Threads
Per intCore - The number of threads per physical core. Can be 1 or 2.
- Threads
Per intCore - The number of threads per physical core. Can be 1 or 2.
- threads
Per IntegerCore - The number of threads per physical core. Can be 1 or 2.
- threads
Per numberCore - The number of threads per physical core. Can be 1 or 2.
- threads_
per_ intcore - The number of threads per physical core. Can be 1 or 2.
- threads
Per NumberCore - The number of threads per physical core. Can be 1 or 2.
GetDatabaseInstancesInstanceSettingBackupConfiguration
- Backup
Retention List<GetSettings Database Instances Instance Setting Backup Configuration Backup Retention Setting> - Binary
Log boolEnabled - 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 bool
- True if backup configuration is enabled.
- Location string
- Location of the backup configuration.
- Point
In boolTime Recovery Enabled - True if Point-in-time recovery is enabled.
- Start
Time string - HH:MM format time indicating when backup configuration starts.
- Transaction
Log intRetention Days - 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 []GetSettings Database Instances Instance Setting Backup Configuration Backup Retention Setting - Binary
Log boolEnabled - 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 bool
- True if backup configuration is enabled.
- Location string
- Location of the backup configuration.
- Point
In boolTime Recovery Enabled - True if Point-in-time recovery is enabled.
- Start
Time string - HH:MM format time indicating when backup configuration starts.
- Transaction
Log intRetention Days - 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 List<GetSettings Database Instances Instance Setting Backup Configuration Backup Retention Setting> - binary
Log BooleanEnabled - 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 Boolean
- True if backup configuration is enabled.
- location String
- Location of the backup configuration.
- point
In BooleanTime Recovery Enabled - True if Point-in-time recovery is enabled.
- start
Time String - HH:MM format time indicating when backup configuration starts.
- transaction
Log IntegerRetention Days - 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 GetSettings Database Instances Instance Setting Backup Configuration Backup Retention Setting[] - binary
Log booleanEnabled - 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 boolean
- True if backup configuration is enabled.
- location string
- Location of the backup configuration.
- point
In booleanTime Recovery Enabled - True if Point-in-time recovery is enabled.
- start
Time string - HH:MM format time indicating when backup configuration starts.
- transaction
Log numberRetention Days - 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_ Sequence[Getsettings Database Instances Instance Setting Backup Configuration Backup Retention Setting] - binary_
log_ boolenabled - 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 bool
- True if backup configuration is enabled.
- location str
- Location of the backup configuration.
- point_
in_ booltime_ recovery_ enabled - True if Point-in-time recovery is enabled.
- start_
time str - HH:MM format time indicating when backup configuration starts.
- transaction_
log_ intretention_ days - 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 List<Property Map>Settings - binary
Log BooleanEnabled - 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 Boolean
- True if backup configuration is enabled.
- location String
- Location of the backup configuration.
- point
In BooleanTime Recovery Enabled - True if Point-in-time recovery is enabled.
- start
Time String - HH:MM format time indicating when backup configuration starts.
- transaction
Log NumberRetention Days - 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.)
GetDatabaseInstancesInstanceSettingBackupConfigurationBackupRetentionSetting
- Retained
Backups int - Number of backups to retain.
- Retention
Unit string - The unit that 'retainedBackups' represents. Defaults to COUNT
- Retained
Backups int - Number of backups to retain.
- Retention
Unit string - The unit that 'retainedBackups' represents. Defaults to COUNT
- retained
Backups Integer - Number of backups to retain.
- retention
Unit String - The unit that 'retainedBackups' represents. Defaults to COUNT
- retained
Backups number - Number of backups to retain.
- retention
Unit string - The unit that 'retainedBackups' represents. Defaults to COUNT
- retained_
backups int - Number of backups to retain.
- retention_
unit str - The unit that 'retainedBackups' represents. Defaults to COUNT
- retained
Backups Number - Number of backups to retain.
- retention
Unit String - The unit that 'retainedBackups' represents. Defaults to COUNT
GetDatabaseInstancesInstanceSettingDataCacheConfig
- Data
Cache boolEnabled - Whether data cache is enabled for the instance.
- Data
Cache boolEnabled - Whether data cache is enabled for the instance.
- data
Cache BooleanEnabled - Whether data cache is enabled for the instance.
- data
Cache booleanEnabled - Whether data cache is enabled for the instance.
- data_
cache_ boolenabled - Whether data cache is enabled for the instance.
- data
Cache BooleanEnabled - Whether data cache is enabled for the instance.
GetDatabaseInstancesInstanceSettingDatabaseFlag
GetDatabaseInstancesInstanceSettingDenyMaintenancePeriod
- End
Date 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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
GetDatabaseInstancesInstanceSettingInsightsConfig
- Query
Insights boolEnabled - True if Query Insights feature is enabled.
- Query
Plans intPer Minute - Number of query execution plans captured by Insights per minute for all queries combined. Between 0 and 20. Default to 5.
- Query
String intLength - Maximum query length stored in bytes. Between 256 and 4500. Default to 1024.
- bool
- True if Query Insights will record application tags from query when enabled.
- Record
Client boolAddress - True if Query Insights will record client address when enabled.
- Query
Insights boolEnabled - True if Query Insights feature is enabled.
- Query
Plans intPer Minute - Number of query execution plans captured by Insights per minute for all queries combined. Between 0 and 20. Default to 5.
- Query
String intLength - Maximum query length stored in bytes. Between 256 and 4500. Default to 1024.
- bool
- True if Query Insights will record application tags from query when enabled.
- Record
Client boolAddress - True if Query Insights will record client address when enabled.
- query
Insights BooleanEnabled - True if Query Insights feature is enabled.
- query
Plans IntegerPer Minute - Number of query execution plans captured by Insights per minute for all queries combined. Between 0 and 20. Default to 5.
- query
String IntegerLength - Maximum query length stored in bytes. Between 256 and 4500. Default to 1024.
- Boolean
- True if Query Insights will record application tags from query when enabled.
- record
Client BooleanAddress - True if Query Insights will record client address when enabled.
- query
Insights booleanEnabled - True if Query Insights feature is enabled.
- query
Plans numberPer Minute - Number of query execution plans captured by Insights per minute for all queries combined. Between 0 and 20. Default to 5.
- query
String numberLength - Maximum query length stored in bytes. Between 256 and 4500. Default to 1024.
- boolean
- True if Query Insights will record application tags from query when enabled.
- record
Client booleanAddress - True if Query Insights will record client address when enabled.
- query_
insights_ boolenabled - True if Query Insights feature is enabled.
- query_
plans_ intper_ minute - Number of query execution plans captured by Insights per minute for all queries combined. Between 0 and 20. Default to 5.
- query_
string_ intlength - Maximum query length stored in bytes. Between 256 and 4500. Default to 1024.
- bool
- True if Query Insights will record application tags from query when enabled.
- record_
client_ booladdress - True if Query Insights will record client address when enabled.
- query
Insights BooleanEnabled - True if Query Insights feature is enabled.
- query
Plans NumberPer Minute - Number of query execution plans captured by Insights per minute for all queries combined. Between 0 and 20. Default to 5.
- query
String NumberLength - Maximum query length stored in bytes. Between 256 and 4500. Default to 1024.
- Boolean
- True if Query Insights will record application tags from query when enabled.
- record
Client BooleanAddress - True if Query Insights will record client address when enabled.
GetDatabaseInstancesInstanceSettingIpConfiguration
- Allocated
Ip stringRange - 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?.
- List<Get
Database Instances Instance Setting Ip Configuration Authorized Network> - Enable
Private boolPath For Google Cloud Services - 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 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 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 List<GetDatabase Instances Instance Setting Ip Configuration Psc Config> - PSC settings for a Cloud SQL instance.
- Server
Ca stringMode - Specify how the server certificate's Certificate Authority is hosted.
- Ssl
Mode string - Specify how SSL connection should be enforced in DB connections.
- Allocated
Ip stringRange - 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?.
- []Get
Database Instances Instance Setting Ip Configuration Authorized Network - Enable
Private boolPath For Google Cloud Services - 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 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 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 []GetDatabase Instances Instance Setting Ip Configuration Psc Config - PSC settings for a Cloud SQL instance.
- Server
Ca stringMode - Specify how the server certificate's Certificate Authority is hosted.
- Ssl
Mode string - Specify how SSL connection should be enforced in DB connections.
- allocated
Ip StringRange - 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?.
- List<Get
Database Instances Instance Setting Ip Configuration Authorized Network> - enable
Private BooleanPath For Google Cloud Services - 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 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 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 List<GetDatabase Instances Instance Setting Ip Configuration Psc Config> - PSC settings for a Cloud SQL instance.
- server
Ca StringMode - Specify how the server certificate's Certificate Authority is hosted.
- ssl
Mode String - Specify how SSL connection should be enforced in DB connections.
- allocated
Ip stringRange - 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?.
- Get
Database Instances Instance Setting Ip Configuration Authorized Network[] - enable
Private booleanPath For Google Cloud Services - 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 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 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 GetDatabase Instances Instance Setting Ip Configuration Psc Config[] - PSC settings for a Cloud SQL instance.
- server
Ca stringMode - Specify how the server certificate's Certificate Authority is hosted.
- ssl
Mode string - Specify how SSL connection should be enforced in DB connections.
- allocated_
ip_ strrange - 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?.
- Sequence[Get
Database Instances Instance Setting Ip Configuration Authorized Network] - enable_
private_ boolpath_ for_ google_ cloud_ services - 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 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 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 Sequence[GetDatabase Instances Instance Setting Ip Configuration Psc Config] - PSC settings for a Cloud SQL instance.
- server_
ca_ strmode - Specify how the server certificate's Certificate Authority is hosted.
- ssl_
mode str - Specify how SSL connection should be enforced in DB connections.
- allocated
Ip StringRange - 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?.
- List<Property Map>
- enable
Private BooleanPath For Google Cloud Services - 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 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 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 List<Property Map> - PSC settings for a Cloud SQL instance.
- server
Ca StringMode - Specify how the server certificate's Certificate Authority is hosted.
- ssl
Mode String - Specify how SSL connection should be enforced in DB connections.
GetDatabaseInstancesInstanceSettingIpConfigurationAuthorizedNetwork
- Expiration
Time string - Name string
- Value string
- Expiration
Time string - Name string
- Value string
- expiration
Time String - name String
- value String
- expiration
Time string - name string
- value string
- expiration_
time str - name str
- value str
- expiration
Time String - name String
- value String
GetDatabaseInstancesInstanceSettingIpConfigurationPscConfig
- Allowed
Consumer List<string>Projects - 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
Enabled bool - Whether PSC connectivity is enabled for this instance.
- Allowed
Consumer []stringProjects - 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
Enabled bool - Whether PSC connectivity is enabled for this instance.
- allowed
Consumer List<String>Projects - 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
Enabled Boolean - Whether PSC connectivity is enabled for this instance.
- allowed
Consumer string[]Projects - 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
Enabled boolean - Whether PSC connectivity is enabled for this instance.
- allowed_
consumer_ Sequence[str]projects - 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_
enabled bool - Whether PSC connectivity is enabled for this instance.
- allowed
Consumer List<String>Projects - 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
Enabled Boolean - Whether PSC connectivity is enabled for this instance.
GetDatabaseInstancesInstanceSettingLocationPreference
- Follow
Gae stringApplication - A Google App Engine application whose zone to remain in. Must be in the same region as this instance.
- Secondary
Zone string - The preferred Compute Engine zone for the secondary/failover
- Zone string
- To filter out the Cloud SQL instances which are located in the specified zone. This zone refers to the Compute Engine zone that the instance is currently serving from.
- Follow
Gae stringApplication - A Google App Engine application whose zone to remain in. Must be in the same region as this instance.
- Secondary
Zone string - The preferred Compute Engine zone for the secondary/failover
- Zone string
- To filter out the Cloud SQL instances which are located in the specified zone. This zone refers to the Compute Engine zone that the instance is currently serving from.
- follow
Gae StringApplication - A Google App Engine application whose zone to remain in. Must be in the same region as this instance.
- secondary
Zone String - The preferred Compute Engine zone for the secondary/failover
- zone String
- To filter out the Cloud SQL instances which are located in the specified zone. This zone refers to the Compute Engine zone that the instance is currently serving from.
- follow
Gae stringApplication - A Google App Engine application whose zone to remain in. Must be in the same region as this instance.
- secondary
Zone string - The preferred Compute Engine zone for the secondary/failover
- zone string
- To filter out the Cloud SQL instances which are located in the specified zone. This zone refers to the Compute Engine zone that the instance is currently serving from.
- follow_
gae_ strapplication - A Google App Engine application whose zone to remain in. Must be in the same region as this instance.
- secondary_
zone str - The preferred Compute Engine zone for the secondary/failover
- zone str
- To filter out the Cloud SQL instances which are located in the specified zone. This zone refers to the Compute Engine zone that the instance is currently serving from.
- follow
Gae StringApplication - A Google App Engine application whose zone to remain in. Must be in the same region as this instance.
- secondary
Zone String - The preferred Compute Engine zone for the secondary/failover
- zone String
- To filter out the Cloud SQL instances which are located in the specified zone. This zone refers to the Compute Engine zone that the instance is currently serving from.
GetDatabaseInstancesInstanceSettingMaintenanceWindow
- Day int
- Day of week (1-7), starting on Monday
- Hour int
- Hour of day (0-23), ignored if day not set
- Update
Track string - Receive updates after one week (canary) or after two weeks (stable) or after five weeks (week5) of notification.
- Day int
- Day of week (1-7), starting on Monday
- Hour int
- Hour of day (0-23), ignored if day not set
- Update
Track string - Receive updates after one week (canary) or after two weeks (stable) or after five weeks (week5) of notification.
- day Integer
- Day of week (1-7), starting on Monday
- hour Integer
- Hour of day (0-23), ignored if day not set
- update
Track String - Receive updates after one week (canary) or after two weeks (stable) or after five weeks (week5) of notification.
- day number
- Day of week (1-7), starting on Monday
- hour number
- Hour of day (0-23), ignored if day not set
- update
Track string - Receive updates after one week (canary) or after two weeks (stable) or after five weeks (week5) of notification.
- day int
- Day of week (1-7), starting on Monday
- hour int
- Hour of day (0-23), ignored if day not set
- update_
track str - Receive updates after one week (canary) or after two weeks (stable) or after five weeks (week5) of notification.
- day Number
- Day of week (1-7), starting on Monday
- hour Number
- Hour of day (0-23), ignored if day not set
- update
Track String - Receive updates after one week (canary) or after two weeks (stable) or after five weeks (week5) of notification.
GetDatabaseInstancesInstanceSettingPasswordValidationPolicy
- Complexity string
- Password complexity.
- Disallow
Username boolSubstring - Disallow username as a part of the password.
- Enable
Password boolPolicy - Whether the password policy is enabled or not.
- Min
Length int - Minimum number of characters allowed.
- Password
Change stringInterval - Minimum interval after which the password can be changed. This flag is only supported for PostgresSQL.
- Reuse
Interval int - Number of previous passwords that cannot be reused.
- Complexity string
- Password complexity.
- Disallow
Username boolSubstring - Disallow username as a part of the password.
- Enable
Password boolPolicy - Whether the password policy is enabled or not.
- Min
Length int - Minimum number of characters allowed.
- Password
Change stringInterval - Minimum interval after which the password can be changed. This flag is only supported for PostgresSQL.
- Reuse
Interval int - Number of previous passwords that cannot be reused.
- complexity String
- Password complexity.
- disallow
Username BooleanSubstring - Disallow username as a part of the password.
- enable
Password BooleanPolicy - Whether the password policy is enabled or not.
- min
Length Integer - Minimum number of characters allowed.
- password
Change StringInterval - Minimum interval after which the password can be changed. This flag is only supported for PostgresSQL.
- reuse
Interval Integer - Number of previous passwords that cannot be reused.
- complexity string
- Password complexity.
- disallow
Username booleanSubstring - Disallow username as a part of the password.
- enable
Password booleanPolicy - Whether the password policy is enabled or not.
- min
Length number - Minimum number of characters allowed.
- password
Change stringInterval - Minimum interval after which the password can be changed. This flag is only supported for PostgresSQL.
- reuse
Interval number - Number of previous passwords that cannot be reused.
- complexity str
- Password complexity.
- disallow_
username_ boolsubstring - Disallow username as a part of the password.
- enable_
password_ boolpolicy - Whether the password policy is enabled or not.
- min_
length int - Minimum number of characters allowed.
- password_
change_ strinterval - Minimum interval after which the password can be changed. This flag is only supported for PostgresSQL.
- reuse_
interval int - Number of previous passwords that cannot be reused.
- complexity String
- Password complexity.
- disallow
Username BooleanSubstring - Disallow username as a part of the password.
- enable
Password BooleanPolicy - Whether the password policy is enabled or not.
- min
Length Number - Minimum number of characters allowed.
- password
Change StringInterval - Minimum interval after which the password can be changed. This flag is only supported for PostgresSQL.
- reuse
Interval Number - Number of previous passwords that cannot be reused.
GetDatabaseInstancesInstanceSettingSqlServerAuditConfig
- Bucket string
- The name of the destination bucket (e.g., gs://mybucket).
- Retention
Interval 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 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 string
- The name of the destination bucket (e.g., gs://mybucket).
- Retention
Interval 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 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 String
- The name of the destination bucket (e.g., gs://mybucket).
- retention
Interval 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 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 string
- The name of the destination bucket (e.g., gs://mybucket).
- retention
Interval 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 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 str
- The name of the destination bucket (e.g., gs://mybucket).
- retention_
interval 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 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 String
- The name of the destination bucket (e.g., gs://mybucket).
- retention
Interval 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 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.