Docs Packages
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. sql
  5. getDatabaseInstance
Google Cloud Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.sql.getDatabaseInstance

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-gcp

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

    Example Usage

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

const qa = gcp.sql.getDatabaseInstance({
    name: "test-sql-instance",
});

    import pulumi
import pulumi_gcp as gcp

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

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sql.LookupDatabaseInstance(ctx, &sql.LookupDatabaseInstanceArgs{
			Name: "test-sql-instance",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

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

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.sql.SqlFunctions;
import com.pulumi.gcp.sql.inputs.GetDatabaseInstanceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var qa = SqlFunctions.getDatabaseInstance(GetDatabaseInstanceArgs.builder()
            .name("test-sql-instance")
            .build());

    }
}

    variables:
  qa:
    fn::invoke:
      Function: gcp:sql:getDatabaseInstance
      Arguments:
        name: test-sql-instance

    Using getDatabaseInstance

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

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

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

    public static class GetDatabaseInstance 
{
    public static Task<GetDatabaseInstanceResult> InvokeAsync(GetDatabaseInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseInstanceResult> Invoke(GetDatabaseInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDatabaseInstanceResult> getDatabaseInstance(GetDatabaseInstanceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: gcp:sql/getDatabaseInstance:getDatabaseInstance
  arguments:
    # arguments dictionary

    The following arguments are supported:

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

    getDatabaseInstance Result

    The following output properties are available:

    Supporting Types

    GetDatabaseInstanceClone

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

    GetDatabaseInstanceIpAddress

    IpAddress string
    TimeToRetire string
    Type string
    IpAddress string
    TimeToRetire string
    Type string
    ipAddress String
    timeToRetire String
    type String
    ipAddress string
    timeToRetire string
    type string
    ipAddress String
    timeToRetire String
    type String

    GetDatabaseInstanceReplicaConfiguration

    CaCertificate string
    PEM representation of the trusted CA's x509 certificate.
    ClientCertificate string
    PEM representation of the replica's x509 certificate.
    ClientKey string
    PEM representation of the replica's private key. The corresponding public key in encoded in the client_certificate.
    ConnectRetryInterval int
    The number of seconds between connect retries. MySQL's default is 60 seconds.
    DumpFilePath string
    Path to a SQL file in Google Cloud Storage from which replica instances are created. Format is gs://bucket/filename.
    FailoverTarget bool
    Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. If the master instance fails, the replica instance will be promoted as the new master instance. Not supported for Postgres
    MasterHeartbeatPeriod int
    Time in ms between replication heartbeats.
    Password string
    Password for the replication connection.
    SslCipher string
    Permissible ciphers for use in SSL encryption.
    Username string
    Username for replication connection.
    VerifyServerCertificate bool
    True if the master's common name value is checked during the SSL handshake.
    CaCertificate string
    PEM representation of the trusted CA's x509 certificate.
    ClientCertificate string
    PEM representation of the replica's x509 certificate.
    ClientKey string
    PEM representation of the replica's private key. The corresponding public key in encoded in the client_certificate.
    ConnectRetryInterval int
    The number of seconds between connect retries. MySQL's default is 60 seconds.
    DumpFilePath string
    Path to a SQL file in Google Cloud Storage from which replica instances are created. Format is gs://bucket/filename.
    FailoverTarget bool
    Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. If the master instance fails, the replica instance will be promoted as the new master instance. Not supported for Postgres
    MasterHeartbeatPeriod int
    Time in ms between replication heartbeats.
    Password string
    Password for the replication connection.
    SslCipher string
    Permissible ciphers for use in SSL encryption.
    Username string
    Username for replication connection.
    VerifyServerCertificate bool
    True if the master's common name value is checked during the SSL handshake.
    caCertificate String
    PEM representation of the trusted CA's x509 certificate.
    clientCertificate String
    PEM representation of the replica's x509 certificate.
    clientKey String
    PEM representation of the replica's private key. The corresponding public key in encoded in the client_certificate.
    connectRetryInterval Integer
    The number of seconds between connect retries. MySQL's default is 60 seconds.
    dumpFilePath String
    Path to a SQL file in Google Cloud Storage from which replica instances are created. Format is gs://bucket/filename.
    failoverTarget Boolean
    Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. If the master instance fails, the replica instance will be promoted as the new master instance. Not supported for Postgres
    masterHeartbeatPeriod Integer
    Time in ms between replication heartbeats.
    password String
    Password for the replication connection.
    sslCipher String
    Permissible ciphers for use in SSL encryption.
    username String
    Username for replication connection.
    verifyServerCertificate Boolean
    True if the master's common name value is checked during the SSL handshake.
    caCertificate string
    PEM representation of the trusted CA's x509 certificate.
    clientCertificate string
    PEM representation of the replica's x509 certificate.
    clientKey string
    PEM representation of the replica's private key. The corresponding public key in encoded in the client_certificate.
    connectRetryInterval number
    The number of seconds between connect retries. MySQL's default is 60 seconds.
    dumpFilePath string
    Path to a SQL file in Google Cloud Storage from which replica instances are created. Format is gs://bucket/filename.
    failoverTarget boolean
    Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. If the master instance fails, the replica instance will be promoted as the new master instance. Not supported for Postgres
    masterHeartbeatPeriod number
    Time in ms between replication heartbeats.
    password string
    Password for the replication connection.
    sslCipher string
    Permissible ciphers for use in SSL encryption.
    username string
    Username for replication connection.
    verifyServerCertificate boolean
    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_interval int
    The number of seconds between connect retries. MySQL's default is 60 seconds.
    dump_file_path str
    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_period int
    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_certificate bool
    True if the master's common name value is checked during the SSL handshake.
    caCertificate String
    PEM representation of the trusted CA's x509 certificate.
    clientCertificate String
    PEM representation of the replica's x509 certificate.
    clientKey String
    PEM representation of the replica's private key. The corresponding public key in encoded in the client_certificate.
    connectRetryInterval Number
    The number of seconds between connect retries. MySQL's default is 60 seconds.
    dumpFilePath String
    Path to a SQL file in Google Cloud Storage from which replica instances are created. Format is gs://bucket/filename.
    failoverTarget Boolean
    Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. If the master instance fails, the replica instance will be promoted as the new master instance. Not supported for Postgres
    masterHeartbeatPeriod Number
    Time in ms between replication heartbeats.
    password String
    Password for the replication connection.
    sslCipher String
    Permissible ciphers for use in SSL encryption.
    username String
    Username for replication connection.
    verifyServerCertificate Boolean
    True if the master's common name value is checked during the SSL handshake.

    GetDatabaseInstanceRestoreBackupContext

    BackupRunId int
    The ID of the backup run to restore from.
    InstanceId string
    The ID of the instance that the backup was taken from.
    Project string
    The ID of the project in which the resource belongs.
    BackupRunId int
    The ID of the backup run to restore from.
    InstanceId string
    The ID of the instance that the backup was taken from.
    Project string
    The ID of the project in which the resource belongs.
    backupRunId Integer
    The ID of the backup run to restore from.
    instanceId String
    The ID of the instance that the backup was taken from.
    project String
    The ID of the project in which the resource belongs.
    backupRunId number
    The ID of the backup run to restore from.
    instanceId string
    The ID of the instance that the backup was taken from.
    project string
    The ID of the project in which the resource belongs.
    backup_run_id int
    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 resource belongs.
    backupRunId Number
    The ID of the backup run to restore from.
    instanceId String
    The ID of the instance that the backup was taken from.
    project String
    The ID of the project in which the resource belongs.

    GetDatabaseInstanceServerCaCert

    Cert string
    The CA Certificate used to connect to the SQL Instance via SSL.
    CommonName string
    The CN valid for the CA Cert.
    CreateTime string
    Creation time of the CA Cert.
    ExpirationTime 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.
    CommonName string
    The CN valid for the CA Cert.
    CreateTime string
    Creation time of the CA Cert.
    ExpirationTime 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.
    commonName String
    The CN valid for the CA Cert.
    createTime String
    Creation time of the CA Cert.
    expirationTime 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.
    commonName string
    The CN valid for the CA Cert.
    createTime string
    Creation time of the CA Cert.
    expirationTime 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.
    commonName String
    The CN valid for the CA Cert.
    createTime String
    Creation time of the CA Cert.
    expirationTime String
    Expiration time of the CA Cert.
    sha1Fingerprint String
    SHA Fingerprint of the CA Cert.

    GetDatabaseInstanceSetting

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

    GetDatabaseInstanceSettingActiveDirectoryConfig

    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).

    GetDatabaseInstanceSettingAdvancedMachineFeature

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

    GetDatabaseInstanceSettingBackupConfiguration

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

    GetDatabaseInstanceSettingBackupConfigurationBackupRetentionSetting

    RetainedBackups int
    Number of backups to retain.
    RetentionUnit string
    The unit that 'retainedBackups' represents. Defaults to COUNT
    RetainedBackups int
    Number of backups to retain.
    RetentionUnit string
    The unit that 'retainedBackups' represents. Defaults to COUNT
    retainedBackups Integer
    Number of backups to retain.
    retentionUnit String
    The unit that 'retainedBackups' represents. Defaults to COUNT
    retainedBackups number
    Number of backups to retain.
    retentionUnit 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
    retainedBackups Number
    Number of backups to retain.
    retentionUnit String
    The unit that 'retainedBackups' represents. Defaults to COUNT

    GetDatabaseInstanceSettingDataCacheConfig

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

    GetDatabaseInstanceSettingDatabaseFlag

    Name string
    The name of the instance.
    Value string
    Value of the flag.
    Name string
    The name of the instance.
    Value string
    Value of the flag.
    name String
    The name of the instance.
    value String
    Value of the flag.
    name string
    The name of the instance.
    value string
    Value of the flag.
    name str
    The name of the instance.
    value str
    Value of the flag.
    name String
    The name of the instance.
    value String
    Value of the flag.

    GetDatabaseInstanceSettingDenyMaintenancePeriod

    EndDate string
    End date before which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
    StartDate 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
    EndDate string
    End date before which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
    StartDate 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
    endDate String
    End date before which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
    startDate 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
    endDate string
    End date before which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
    startDate 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
    endDate String
    End date before which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
    startDate 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

    GetDatabaseInstanceSettingInsightsConfig

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

    GetDatabaseInstanceSettingIpConfiguration

    AllocatedIpRange string
    The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
    AuthorizedNetworks List<GetDatabaseInstanceSettingIpConfigurationAuthorizedNetwork>
    EnablePrivatePathForGoogleCloudServices bool
    Whether Google Cloud services such as BigQuery are allowed to access data in this Cloud SQL instance over a private IP connection. SQLSERVER database type is not supported.
    Ipv4Enabled bool
    Whether this Cloud SQL instance should be assigned a public IPV4 address. At least ipv4_enabled must be enabled or a private_network must be configured.
    PrivateNetwork string
    The VPC network from which the Cloud SQL instance is accessible for private IP. For example, projects/myProject/global/networks/default. Specifying a network enables private IP. At least ipv4_enabled must be enabled or a private_network must be configured. This setting can be updated, but it cannot be removed after it is set.
    PscConfigs List<GetDatabaseInstanceSettingIpConfigurationPscConfig>
    PSC settings for a Cloud SQL instance.
    RequireSsl bool
    Whether SSL connections over IP are enforced or not. To change this field, also set the corresponding value in ssl_mode if it has been set too.
    SslMode string
    Specify how SSL connection should be enforced in DB connections. This field provides more SSL enforcment options compared to require_ssl. To change this field, also set the correspoding value in require_ssl until next major release.
    AllocatedIpRange string
    The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
    AuthorizedNetworks []GetDatabaseInstanceSettingIpConfigurationAuthorizedNetwork
    EnablePrivatePathForGoogleCloudServices bool
    Whether Google Cloud services such as BigQuery are allowed to access data in this Cloud SQL instance over a private IP connection. SQLSERVER database type is not supported.
    Ipv4Enabled bool
    Whether this Cloud SQL instance should be assigned a public IPV4 address. At least ipv4_enabled must be enabled or a private_network must be configured.
    PrivateNetwork string
    The VPC network from which the Cloud SQL instance is accessible for private IP. For example, projects/myProject/global/networks/default. Specifying a network enables private IP. At least ipv4_enabled must be enabled or a private_network must be configured. This setting can be updated, but it cannot be removed after it is set.
    PscConfigs []GetDatabaseInstanceSettingIpConfigurationPscConfig
    PSC settings for a Cloud SQL instance.
    RequireSsl bool
    Whether SSL connections over IP are enforced or not. To change this field, also set the corresponding value in ssl_mode if it has been set too.
    SslMode string
    Specify how SSL connection should be enforced in DB connections. This field provides more SSL enforcment options compared to require_ssl. To change this field, also set the correspoding value in require_ssl until next major release.
    allocatedIpRange String
    The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
    authorizedNetworks List<GetDatabaseInstanceSettingIpConfigurationAuthorizedNetwork>
    enablePrivatePathForGoogleCloudServices Boolean
    Whether Google Cloud services such as BigQuery are allowed to access data in this Cloud SQL instance over a private IP connection. SQLSERVER database type is not supported.
    ipv4Enabled Boolean
    Whether this Cloud SQL instance should be assigned a public IPV4 address. At least ipv4_enabled must be enabled or a private_network must be configured.
    privateNetwork String
    The VPC network from which the Cloud SQL instance is accessible for private IP. For example, projects/myProject/global/networks/default. Specifying a network enables private IP. At least ipv4_enabled must be enabled or a private_network must be configured. This setting can be updated, but it cannot be removed after it is set.
    pscConfigs List<GetDatabaseInstanceSettingIpConfigurationPscConfig>
    PSC settings for a Cloud SQL instance.
    requireSsl Boolean
    Whether SSL connections over IP are enforced or not. To change this field, also set the corresponding value in ssl_mode if it has been set too.
    sslMode String
    Specify how SSL connection should be enforced in DB connections. This field provides more SSL enforcment options compared to require_ssl. To change this field, also set the correspoding value in require_ssl until next major release.
    allocatedIpRange string
    The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
    authorizedNetworks GetDatabaseInstanceSettingIpConfigurationAuthorizedNetwork[]
    enablePrivatePathForGoogleCloudServices boolean
    Whether Google Cloud services such as BigQuery are allowed to access data in this Cloud SQL instance over a private IP connection. SQLSERVER database type is not supported.
    ipv4Enabled boolean
    Whether this Cloud SQL instance should be assigned a public IPV4 address. At least ipv4_enabled must be enabled or a private_network must be configured.
    privateNetwork string
    The VPC network from which the Cloud SQL instance is accessible for private IP. For example, projects/myProject/global/networks/default. Specifying a network enables private IP. At least ipv4_enabled must be enabled or a private_network must be configured. This setting can be updated, but it cannot be removed after it is set.
    pscConfigs GetDatabaseInstanceSettingIpConfigurationPscConfig[]
    PSC settings for a Cloud SQL instance.
    requireSsl boolean
    Whether SSL connections over IP are enforced or not. To change this field, also set the corresponding value in ssl_mode if it has been set too.
    sslMode string
    Specify how SSL connection should be enforced in DB connections. This field provides more SSL enforcment options compared to require_ssl. To change this field, also set the correspoding value in require_ssl until next major release.
    allocated_ip_range str
    The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
    authorized_networks Sequence[GetDatabaseInstanceSettingIpConfigurationAuthorizedNetwork]
    enable_private_path_for_google_cloud_services bool
    Whether Google Cloud services such as BigQuery are allowed to access data in this Cloud SQL instance over a private IP connection. SQLSERVER database type is not supported.
    ipv4_enabled 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[GetDatabaseInstanceSettingIpConfigurationPscConfig]
    PSC settings for a Cloud SQL instance.
    require_ssl bool
    Whether SSL connections over IP are enforced or not. To change this field, also set the corresponding value in ssl_mode if it has been set too.
    ssl_mode str
    Specify how SSL connection should be enforced in DB connections. This field provides more SSL enforcment options compared to require_ssl. To change this field, also set the correspoding value in require_ssl until next major release.
    allocatedIpRange String
    The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?.
    authorizedNetworks List<Property Map>
    enablePrivatePathForGoogleCloudServices Boolean
    Whether Google Cloud services such as BigQuery are allowed to access data in this Cloud SQL instance over a private IP connection. SQLSERVER database type is not supported.
    ipv4Enabled Boolean
    Whether this Cloud SQL instance should be assigned a public IPV4 address. At least ipv4_enabled must be enabled or a private_network must be configured.
    privateNetwork String
    The VPC network from which the Cloud SQL instance is accessible for private IP. For example, projects/myProject/global/networks/default. Specifying a network enables private IP. At least ipv4_enabled must be enabled or a private_network must be configured. This setting can be updated, but it cannot be removed after it is set.
    pscConfigs List<Property Map>
    PSC settings for a Cloud SQL instance.
    requireSsl Boolean
    Whether SSL connections over IP are enforced or not. To change this field, also set the corresponding value in ssl_mode if it has been set too.
    sslMode String
    Specify how SSL connection should be enforced in DB connections. This field provides more SSL enforcment options compared to require_ssl. To change this field, also set the correspoding value in require_ssl until next major release.

    GetDatabaseInstanceSettingIpConfigurationAuthorizedNetwork

    ExpirationTime string
    Name string
    The name of the instance.
    Value string
    ExpirationTime string
    Name string
    The name of the instance.
    Value string
    expirationTime String
    name String
    The name of the instance.
    value String
    expirationTime string
    name string
    The name of the instance.
    value string
    expiration_time str
    name str
    The name of the instance.
    value str
    expirationTime String
    name String
    The name of the instance.
    value String

    GetDatabaseInstanceSettingIpConfigurationPscConfig

    AllowedConsumerProjects List<string>
    List of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
    PscEnabled bool
    Whether PSC connectivity is enabled for this instance.
    AllowedConsumerProjects []string
    List of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
    PscEnabled bool
    Whether PSC connectivity is enabled for this instance.
    allowedConsumerProjects List<String>
    List of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
    pscEnabled Boolean
    Whether PSC connectivity is enabled for this instance.
    allowedConsumerProjects string[]
    List of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
    pscEnabled boolean
    Whether PSC connectivity is enabled for this instance.
    allowed_consumer_projects Sequence[str]
    List of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
    psc_enabled bool
    Whether PSC connectivity is enabled for this instance.
    allowedConsumerProjects List<String>
    List of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
    pscEnabled Boolean
    Whether PSC connectivity is enabled for this instance.

    GetDatabaseInstanceSettingLocationPreference

    FollowGaeApplication string
    A Google App Engine application whose zone to remain in. Must be in the same region as this instance.
    SecondaryZone string
    The preferred Compute Engine zone for the secondary/failover
    Zone string
    The preferred compute engine zone.
    FollowGaeApplication string
    A Google App Engine application whose zone to remain in. Must be in the same region as this instance.
    SecondaryZone string
    The preferred Compute Engine zone for the secondary/failover
    Zone string
    The preferred compute engine zone.
    followGaeApplication String
    A Google App Engine application whose zone to remain in. Must be in the same region as this instance.
    secondaryZone String
    The preferred Compute Engine zone for the secondary/failover
    zone String
    The preferred compute engine zone.
    followGaeApplication string
    A Google App Engine application whose zone to remain in. Must be in the same region as this instance.
    secondaryZone string
    The preferred Compute Engine zone for the secondary/failover
    zone string
    The preferred compute engine zone.
    follow_gae_application str
    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
    The preferred compute engine zone.
    followGaeApplication String
    A Google App Engine application whose zone to remain in. Must be in the same region as this instance.
    secondaryZone String
    The preferred Compute Engine zone for the secondary/failover
    zone String
    The preferred compute engine zone.

    GetDatabaseInstanceSettingMaintenanceWindow

    Day int
    Day of week (1-7), starting on Monday
    Hour int
    Hour of day (0-23), ignored if day not set
    UpdateTrack 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
    UpdateTrack 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
    updateTrack 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
    updateTrack 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
    updateTrack String
    Receive updates after one week (canary) or after two weeks (stable) or after five weeks (week5) of notification.

    GetDatabaseInstanceSettingPasswordValidationPolicy

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

    GetDatabaseInstanceSettingSqlServerAuditConfig

    Bucket string
    The name of the destination bucket (e.g., gs://mybucket).
    RetentionInterval string
    How long to keep generated audit files. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s"..
    UploadInterval 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).
    RetentionInterval string
    How long to keep generated audit files. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s"..
    UploadInterval 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).
    retentionInterval String
    How long to keep generated audit files. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s"..
    uploadInterval 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).
    retentionInterval string
    How long to keep generated audit files. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s"..
    uploadInterval 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).
    retentionInterval String
    How long to keep generated audit files. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s"..
    uploadInterval 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.
    gcp logo
    Google Cloud Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-gcp