export declare const BackupRetentionSettingsRetentionUnit: { /** * Backup retention unit is unspecified, will be treated as COUNT. */ readonly RetentionUnitUnspecified: "RETENTION_UNIT_UNSPECIFIED"; /** * Retention will be by count, eg. "retain the most recent 7 backups". */ readonly Count: "COUNT"; }; /** * The unit that 'retained_backups' represents. */ export type BackupRetentionSettingsRetentionUnit = (typeof BackupRetentionSettingsRetentionUnit)[keyof typeof BackupRetentionSettingsRetentionUnit]; export declare const BackupRunBackupKind: { /** * This is an unknown BackupKind. */ readonly SqlBackupKindUnspecified: "SQL_BACKUP_KIND_UNSPECIFIED"; /** * The snapshot based backups */ readonly Snapshot: "SNAPSHOT"; /** * Physical backups */ readonly Physical: "PHYSICAL"; }; /** * Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. */ export type BackupRunBackupKind = (typeof BackupRunBackupKind)[keyof typeof BackupRunBackupKind]; export declare const BackupRunStatus: { /** * The status of the run is unknown. */ readonly SqlBackupRunStatusUnspecified: "SQL_BACKUP_RUN_STATUS_UNSPECIFIED"; /** * The backup operation was enqueued. */ readonly Enqueued: "ENQUEUED"; /** * The backup is overdue across a given backup window. Indicates a problem. Example: Long-running operation in progress during the whole window. */ readonly Overdue: "OVERDUE"; /** * The backup is in progress. */ readonly Running: "RUNNING"; /** * The backup failed. */ readonly Failed: "FAILED"; /** * The backup was successful. */ readonly Successful: "SUCCESSFUL"; /** * The backup was skipped (without problems) for a given backup window. Example: Instance was idle. */ readonly Skipped: "SKIPPED"; /** * The backup is about to be deleted. */ readonly DeletionPending: "DELETION_PENDING"; /** * The backup deletion failed. */ readonly DeletionFailed: "DELETION_FAILED"; /** * The backup has been deleted. */ readonly Deleted: "DELETED"; }; /** * The status of this run. */ export type BackupRunStatus = (typeof BackupRunStatus)[keyof typeof BackupRunStatus]; export declare const BackupRunType: { /** * This is an unknown BackupRun type. */ readonly SqlBackupRunTypeUnspecified: "SQL_BACKUP_RUN_TYPE_UNSPECIFIED"; /** * The backup schedule automatically triggers a backup. */ readonly Automated: "AUTOMATED"; /** * The user manually triggers a backup. */ readonly OnDemand: "ON_DEMAND"; }; /** * The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests. */ export type BackupRunType = (typeof BackupRunType)[keyof typeof BackupRunType]; export declare const InstanceBackendType: { /** * This is an unknown backend type for instance. */ readonly SqlBackendTypeUnspecified: "SQL_BACKEND_TYPE_UNSPECIFIED"; /** * V1 speckle instance. */ readonly FirstGen: "FIRST_GEN"; /** * V2 speckle instance. */ readonly SecondGen: "SECOND_GEN"; /** * On premises instance. */ readonly External: "EXTERNAL"; }; /** * The backend type. `SECOND_GEN`: Cloud SQL database instance. `EXTERNAL`: A database server that is not managed by Google. This property is read-only; use the `tier` property in the `settings` object to determine the database type. */ export type InstanceBackendType = (typeof InstanceBackendType)[keyof typeof InstanceBackendType]; export declare const InstanceDatabaseVersion: { /** * This is an unknown database version. */ readonly SqlDatabaseVersionUnspecified: "SQL_DATABASE_VERSION_UNSPECIFIED"; /** * The database version is MySQL 5.1. */ readonly Mysql51: "MYSQL_5_1"; /** * The database version is MySQL 5.5. */ readonly Mysql55: "MYSQL_5_5"; /** * The database version is MySQL 5.6. */ readonly Mysql56: "MYSQL_5_6"; /** * The database version is MySQL 5.7. */ readonly Mysql57: "MYSQL_5_7"; /** * The database version is SQL Server 2017 Standard. */ readonly Sqlserver2017Standard: "SQLSERVER_2017_STANDARD"; /** * The database version is SQL Server 2017 Enterprise. */ readonly Sqlserver2017Enterprise: "SQLSERVER_2017_ENTERPRISE"; /** * The database version is SQL Server 2017 Express. */ readonly Sqlserver2017Express: "SQLSERVER_2017_EXPRESS"; /** * The database version is SQL Server 2017 Web. */ readonly Sqlserver2017Web: "SQLSERVER_2017_WEB"; /** * The database version is PostgreSQL 9.6. */ readonly Postgres96: "POSTGRES_9_6"; /** * The database version is PostgreSQL 10. */ readonly Postgres10: "POSTGRES_10"; /** * The database version is PostgreSQL 11. */ readonly Postgres11: "POSTGRES_11"; /** * The database version is PostgreSQL 12. */ readonly Postgres12: "POSTGRES_12"; /** * The database version is PostgreSQL 13. */ readonly Postgres13: "POSTGRES_13"; /** * The database version is PostgreSQL 14. */ readonly Postgres14: "POSTGRES_14"; /** * The database version is PostgreSQL 15. */ readonly Postgres15: "POSTGRES_15"; /** * The database version is MySQL 8. */ readonly Mysql80: "MYSQL_8_0"; /** * The database major version is MySQL 8.0 and the minor version is 18. */ readonly Mysql8018: "MYSQL_8_0_18"; /** * The database major version is MySQL 8.0 and the minor version is 26. */ readonly Mysql8026: "MYSQL_8_0_26"; /** * The database major version is MySQL 8.0 and the minor version is 27. */ readonly Mysql8027: "MYSQL_8_0_27"; /** * The database major version is MySQL 8.0 and the minor version is 28. */ readonly Mysql8028: "MYSQL_8_0_28"; /** * The database major version is MySQL 8.0 and the minor version is 29. */ readonly Mysql8029: "MYSQL_8_0_29"; /** * The database major version is MySQL 8.0 and the minor version is 30. */ readonly Mysql8030: "MYSQL_8_0_30"; /** * The database major version is MySQL 8.0 and the minor version is 31. */ readonly Mysql8031: "MYSQL_8_0_31"; /** * The database major version is MySQL 8.0 and the minor version is 32. */ readonly Mysql8032: "MYSQL_8_0_32"; /** * The database major version is MySQL 8.0 and the minor version is 33. */ readonly Mysql8033: "MYSQL_8_0_33"; /** * The database major version is MySQL 8.0 and the minor version is 34. */ readonly Mysql8034: "MYSQL_8_0_34"; /** * The database major version is MySQL 8.0 and the minor version is 35. */ readonly Mysql8035: "MYSQL_8_0_35"; /** * The database major version is MySQL 8.0 and the minor version is 36. */ readonly Mysql8036: "MYSQL_8_0_36"; /** * The database version is SQL Server 2019 Standard. */ readonly Sqlserver2019Standard: "SQLSERVER_2019_STANDARD"; /** * The database version is SQL Server 2019 Enterprise. */ readonly Sqlserver2019Enterprise: "SQLSERVER_2019_ENTERPRISE"; /** * The database version is SQL Server 2019 Express. */ readonly Sqlserver2019Express: "SQLSERVER_2019_EXPRESS"; /** * The database version is SQL Server 2019 Web. */ readonly Sqlserver2019Web: "SQLSERVER_2019_WEB"; /** * The database version is SQL Server 2022 Standard. */ readonly Sqlserver2022Standard: "SQLSERVER_2022_STANDARD"; /** * The database version is SQL Server 2022 Enterprise. */ readonly Sqlserver2022Enterprise: "SQLSERVER_2022_ENTERPRISE"; /** * The database version is SQL Server 2022 Express. */ readonly Sqlserver2022Express: "SQLSERVER_2022_EXPRESS"; /** * The database version is SQL Server 2022 Web. */ readonly Sqlserver2022Web: "SQLSERVER_2022_WEB"; }; /** * The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. */ export type InstanceDatabaseVersion = (typeof InstanceDatabaseVersion)[keyof typeof InstanceDatabaseVersion]; export declare const InstanceInstanceType: { /** * This is an unknown Cloud SQL instance type. */ readonly SqlInstanceTypeUnspecified: "SQL_INSTANCE_TYPE_UNSPECIFIED"; /** * A regular Cloud SQL instance that is not replicating from a primary instance. */ readonly CloudSqlInstance: "CLOUD_SQL_INSTANCE"; /** * An instance running on the customer's premises that is not managed by Cloud SQL. */ readonly OnPremisesInstance: "ON_PREMISES_INSTANCE"; /** * A Cloud SQL instance acting as a read-replica. */ readonly ReadReplicaInstance: "READ_REPLICA_INSTANCE"; }; /** * The instance type. */ export type InstanceInstanceType = (typeof InstanceInstanceType)[keyof typeof InstanceInstanceType]; export declare const InstanceSqlNetworkArchitecture: { readonly SqlNetworkArchitectureUnspecified: "SQL_NETWORK_ARCHITECTURE_UNSPECIFIED"; /** * Instance is a Tenancy Unit (TU) instance. */ readonly NewNetworkArchitecture: "NEW_NETWORK_ARCHITECTURE"; /** * Instance is an Umbrella instance. */ readonly OldNetworkArchitecture: "OLD_NETWORK_ARCHITECTURE"; }; export type InstanceSqlNetworkArchitecture = (typeof InstanceSqlNetworkArchitecture)[keyof typeof InstanceSqlNetworkArchitecture]; export declare const InstanceState: { /** * The state of the instance is unknown. */ readonly SqlInstanceStateUnspecified: "SQL_INSTANCE_STATE_UNSPECIFIED"; /** * The instance is running, or has been stopped by owner. */ readonly Runnable: "RUNNABLE"; /** * The instance is not available, for example due to problems with billing. */ readonly Suspended: "SUSPENDED"; /** * The instance is being deleted. */ readonly PendingDelete: "PENDING_DELETE"; /** * The instance is being created. */ readonly PendingCreate: "PENDING_CREATE"; /** * The instance is down for maintenance. */ readonly Maintenance: "MAINTENANCE"; /** * The creation of the instance failed or a fatal error occurred during maintenance. */ readonly Failed: "FAILED"; /** * Deprecated */ readonly OnlineMaintenance: "ONLINE_MAINTENANCE"; }; /** * The current serving state of the Cloud SQL instance. */ export type InstanceState = (typeof InstanceState)[keyof typeof InstanceState]; export declare const InstanceSuspensionReasonItem: { /** * This is an unknown suspension reason. */ readonly SqlSuspensionReasonUnspecified: "SQL_SUSPENSION_REASON_UNSPECIFIED"; /** * The instance is suspended due to billing issues (for example:, GCP account issue) */ readonly BillingIssue: "BILLING_ISSUE"; /** * The instance is suspended due to illegal content (for example:, child pornography, copyrighted material, etc.). */ readonly LegalIssue: "LEGAL_ISSUE"; /** * The instance is causing operational issues (for example:, causing the database to crash). */ readonly OperationalIssue: "OPERATIONAL_ISSUE"; /** * The KMS key used by the instance is either revoked or denied access to */ readonly KmsKeyIssue: "KMS_KEY_ISSUE"; }; export type InstanceSuspensionReasonItem = (typeof InstanceSuspensionReasonItem)[keyof typeof InstanceSuspensionReasonItem]; export declare const IpConfigurationSslMode: { /** * The SSL mode is unknown. */ readonly SslModeUnspecified: "SSL_MODE_UNSPECIFIED"; /** * Allow non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. When this value is used, the legacy `require_ssl` flag must be false or cleared to avoid the conflict between values of two flags. */ readonly AllowUnencryptedAndEncrypted: "ALLOW_UNENCRYPTED_AND_ENCRYPTED"; /** * Only allow connections encrypted with SSL/TLS. When this value is used, the legacy `require_ssl` flag must be false or cleared to avoid the conflict between values of two flags. */ readonly EncryptedOnly: "ENCRYPTED_ONLY"; /** * Only allow connections encrypted with SSL/TLS and with valid client certificates. When this value is used, the legacy `require_ssl` flag must be true or cleared to avoid the conflict between values of two flags. */ readonly TrustedClientCertificateRequired: "TRUSTED_CLIENT_CERTIFICATE_REQUIRED"; }; /** * Specify how SSL/TLS is enforced in database connections. This flag is supported only for PostgreSQL. Use the legacy `require_ssl` flag for enforcing SSL/TLS in MySQL and SQL Server. But, for PostgreSQL, use the `ssl_mode` flag instead of the legacy `require_ssl` flag. To avoid the conflict between those flags in PostgreSQL, only the following value pairs are valid: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` Note that the value of `ssl_mode` gets priority over the value of the legacy `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY, require_ssl=false`, the `ssl_mode=ENCRYPTED_ONLY` means "only accepts SSL connection", while the `require_ssl=false` means "both non-SSL and SSL connections are allowed". The database respects `ssl_mode` in this case and only accepts SSL connections. */ export type IpConfigurationSslMode = (typeof IpConfigurationSslMode)[keyof typeof IpConfigurationSslMode]; export declare const IpMappingType: { /** * This is an unknown IP address type. */ readonly SqlIpAddressTypeUnspecified: "SQL_IP_ADDRESS_TYPE_UNSPECIFIED"; /** * IP address the customer is supposed to connect to. Usually this is the load balancer's IP address */ readonly Primary: "PRIMARY"; /** * Source IP address of the connection a read replica establishes to its external primary instance. This IP address can be allowlisted by the customer in case it has a firewall that filters incoming connection to its on premises primary instance. */ readonly Outgoing: "OUTGOING"; /** * Private IP used when using private IPs and network peering. */ readonly Private: "PRIVATE"; /** * V1 IP of a migrated instance. We want the user to decommission this IP as soon as the migration is complete. Note: V1 instances with V1 ip addresses will be counted as PRIMARY. */ readonly Migrated1stGen: "MIGRATED_1ST_GEN"; }; /** * The type of this IP address. A `PRIMARY` address is a public address that can accept incoming connections. A `PRIVATE` address is a private address that can accept incoming connections. An `OUTGOING` address is the source address of connections originating from the instance, if supported. */ export type IpMappingType = (typeof IpMappingType)[keyof typeof IpMappingType]; export declare const MaintenanceWindowUpdateTrack: { /** * This is an unknown maintenance timing preference. */ readonly SqlUpdateTrackUnspecified: "SQL_UPDATE_TRACK_UNSPECIFIED"; /** * For instance update that requires a restart, this update track indicates your instance prefer to restart for new version early in maintenance window. */ readonly Canary: "canary"; /** * For instance update that requires a restart, this update track indicates your instance prefer to let Cloud SQL choose the timing of restart (within its Maintenance window, if applicable). */ readonly Stable: "stable"; /** * For instance update that requires a restart, this update track indicates your instance prefer to let Cloud SQL choose the timing of restart (within its Maintenance window, if applicable) to be at least 5 weeks after the notification. */ readonly Week5: "week5"; }; /** * Maintenance timing setting: `canary` (Earlier) or `stable` (Later). [Learn more](https://cloud.google.com/sql/docs/mysql/instance-settings#maintenance-timing-2ndgen). */ export type MaintenanceWindowUpdateTrack = (typeof MaintenanceWindowUpdateTrack)[keyof typeof MaintenanceWindowUpdateTrack]; export declare const PasswordValidationPolicyComplexity: { /** * Complexity check is not specified. */ readonly ComplexityUnspecified: "COMPLEXITY_UNSPECIFIED"; /** * A combination of lowercase, uppercase, numeric, and non-alphanumeric characters. */ readonly ComplexityDefault: "COMPLEXITY_DEFAULT"; }; /** * The complexity of the password. */ export type PasswordValidationPolicyComplexity = (typeof PasswordValidationPolicyComplexity)[keyof typeof PasswordValidationPolicyComplexity]; export declare const SettingsActivationPolicy: { /** * Unknown activation plan. */ readonly SqlActivationPolicyUnspecified: "SQL_ACTIVATION_POLICY_UNSPECIFIED"; /** * The instance is always up and running. */ readonly Always: "ALWAYS"; /** * The instance never starts. */ readonly Never: "NEVER"; /** * The instance starts upon receiving requests. */ readonly OnDemand: "ON_DEMAND"; }; /** * The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: * `ALWAYS`: The instance is on, and remains so even in the absence of connection requests. * `NEVER`: The instance is off; it is not activated, even if a connection request arrives. */ export type SettingsActivationPolicy = (typeof SettingsActivationPolicy)[keyof typeof SettingsActivationPolicy]; export declare const SettingsAvailabilityType: { /** * This is an unknown Availability type. */ readonly SqlAvailabilityTypeUnspecified: "SQL_AVAILABILITY_TYPE_UNSPECIFIED"; /** * Zonal available instance. */ readonly Zonal: "ZONAL"; /** * Regional available instance. */ readonly Regional: "REGIONAL"; }; /** * Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available)./ For more information, see [Overview of the High Availability Configuration](https://cloud.google.com/sql/docs/mysql/high-availability). */ export type SettingsAvailabilityType = (typeof SettingsAvailabilityType)[keyof typeof SettingsAvailabilityType]; export declare const SettingsConnectorEnforcement: { /** * The requirement for Cloud SQL connectors is unknown. */ readonly ConnectorEnforcementUnspecified: "CONNECTOR_ENFORCEMENT_UNSPECIFIED"; /** * Do not require Cloud SQL connectors. */ readonly NotRequired: "NOT_REQUIRED"; /** * Require all connections to use Cloud SQL connectors, including the Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors. Note: This disables all existing authorized networks. */ readonly Required: "REQUIRED"; }; /** * Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance. */ export type SettingsConnectorEnforcement = (typeof SettingsConnectorEnforcement)[keyof typeof SettingsConnectorEnforcement]; export declare const SettingsDataDiskType: { /** * This is an unknown data disk type. */ readonly SqlDataDiskTypeUnspecified: "SQL_DATA_DISK_TYPE_UNSPECIFIED"; /** * An SSD data disk. */ readonly PdSsd: "PD_SSD"; /** * An HDD data disk. */ readonly PdHdd: "PD_HDD"; /** * This field is deprecated and will be removed from a future version of the API. */ readonly ObsoleteLocalSsd: "OBSOLETE_LOCAL_SSD"; }; /** * The type of data disk: `PD_SSD` (default) or `PD_HDD`. Not used for First Generation instances. */ export type SettingsDataDiskType = (typeof SettingsDataDiskType)[keyof typeof SettingsDataDiskType]; export declare const SettingsEdition: { /** * The instance did not specify the edition. */ readonly EditionUnspecified: "EDITION_UNSPECIFIED"; /** * The instance is an enterprise edition. */ readonly Enterprise: "ENTERPRISE"; /** * The instance is an Enterprise Plus edition. */ readonly EnterprisePlus: "ENTERPRISE_PLUS"; }; /** * Optional. The edition of the instance. */ export type SettingsEdition = (typeof SettingsEdition)[keyof typeof SettingsEdition]; export declare const SettingsPricingPlan: { /** * This is an unknown pricing plan for this instance. */ readonly SqlPricingPlanUnspecified: "SQL_PRICING_PLAN_UNSPECIFIED"; /** * The instance is billed at a monthly flat rate. */ readonly Package: "PACKAGE"; /** * The instance is billed per usage. */ readonly PerUse: "PER_USE"; }; /** * The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. */ export type SettingsPricingPlan = (typeof SettingsPricingPlan)[keyof typeof SettingsPricingPlan]; export declare const SettingsReplicationType: { /** * This is an unknown replication type for a Cloud SQL instance. */ readonly SqlReplicationTypeUnspecified: "SQL_REPLICATION_TYPE_UNSPECIFIED"; /** * The synchronous replication mode for First Generation instances. It is the default value. */ readonly Synchronous: "SYNCHRONOUS"; /** * The asynchronous replication mode for First Generation instances. It provides a slight performance gain, but if an outage occurs while this option is set to asynchronous, you can lose up to a few seconds of updates to your data. */ readonly Asynchronous: "ASYNCHRONOUS"; }; /** * The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances. */ export type SettingsReplicationType = (typeof SettingsReplicationType)[keyof typeof SettingsReplicationType]; export declare const SqlOutOfDiskReportSqlOutOfDiskState: { /** * Unspecified state */ readonly SqlOutOfDiskStateUnspecified: "SQL_OUT_OF_DISK_STATE_UNSPECIFIED"; /** * The instance has plenty space on data disk */ readonly Normal: "NORMAL"; /** * Data disk is almost used up. It is shutdown to prevent data corruption. */ readonly SoftShutdown: "SOFT_SHUTDOWN"; }; /** * This field represents the state generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job */ export type SqlOutOfDiskReportSqlOutOfDiskState = (typeof SqlOutOfDiskReportSqlOutOfDiskState)[keyof typeof SqlOutOfDiskReportSqlOutOfDiskState]; export declare const UserDualPasswordType: { /** * The default value. */ readonly DualPasswordTypeUnspecified: "DUAL_PASSWORD_TYPE_UNSPECIFIED"; /** * Do not update the user's dual password status. */ readonly NoModifyDualPassword: "NO_MODIFY_DUAL_PASSWORD"; /** * No dual password usable for connecting using this user. */ readonly NoDualPassword: "NO_DUAL_PASSWORD"; /** * Dual password usable for connecting using this user. */ readonly DualPassword: "DUAL_PASSWORD"; }; /** * Dual password status for the user. */ export type UserDualPasswordType = (typeof UserDualPasswordType)[keyof typeof UserDualPasswordType]; export declare const UserType: { /** * The database's built-in user type. */ readonly BuiltIn: "BUILT_IN"; /** * Cloud IAM user. */ readonly CloudIamUser: "CLOUD_IAM_USER"; /** * Cloud IAM service account. */ readonly CloudIamServiceAccount: "CLOUD_IAM_SERVICE_ACCOUNT"; /** * Cloud IAM Group non-login user. */ readonly CloudIamGroup: "CLOUD_IAM_GROUP"; /** * Cloud IAM Group login user. */ readonly CloudIamGroupUser: "CLOUD_IAM_GROUP_USER"; /** * Cloud IAM Group login service account. */ readonly CloudIamGroupServiceAccount: "CLOUD_IAM_GROUP_SERVICE_ACCOUNT"; }; /** * The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type. */ export type UserType = (typeof UserType)[keyof typeof UserType];