Class Settings (0.1.1) 

Settings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Database instance settings.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name Description
settings_version google.protobuf.wrappers_pb2.Int64Value
The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
authorized_gae_applications MutableSequence[str]
The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
tier str
The tier (or machine type) for this instance, for example db-custom-1-3840. WARNING: Changing this restarts the instance.
kind str
This is always sql#settings.
user_labels MutableMapping[str, str]
User-provided labels, represented as a dictionary where each label is a single key value pair.
availability_type google.cloud.sqladmin_v1.types.SqlAvailabilityType
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
pricing_plan google.cloud.sqladmin_v1.types.SqlPricingPlan
The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances.
replication_type google.cloud.sqladmin_v1.types.SqlReplicationType
The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. (Deprecated) This property was only applicable to First Generation instances.
storage_auto_resize_limit google.protobuf.wrappers_pb2.Int64Value
The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
activation_policy google.cloud.sqladmin_v1.types.Settings.SqlActivationPolicy
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.
ip_configuration google.cloud.sqladmin_v1.types.IpConfiguration
The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances.
storage_auto_resize google.protobuf.wrappers_pb2.BoolValue
Configuration to increase storage size automatically. The default value is true.
location_preference google.cloud.sqladmin_v1.types.LocationPreference
The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances.
database_flags MutableSequence[google.cloud.sqladmin_v1.types.DatabaseFlags]
The database flags passed to the instance at startup.
data_disk_type google.cloud.sqladmin_v1.types.SqlDataDiskType
The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.
maintenance_window google.cloud.sqladmin_v1.types.MaintenanceWindow
The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.
backup_configuration google.cloud.sqladmin_v1.types.BackupConfiguration
The daily backup configuration for the instance.
database_replication_enabled google.protobuf.wrappers_pb2.BoolValue
Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.
crash_safe_replication_enabled google.protobuf.wrappers_pb2.BoolValue
Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
data_disk_size_gb google.protobuf.wrappers_pb2.Int64Value
The size of data disk, in GB. The data disk size minimum is 10GB.
active_directory_config google.cloud.sqladmin_v1.types.SqlActiveDirectoryConfig
Active Directory configuration, relevant only for Cloud SQL for SQL Server.
collation str
The name of server Instance collation.
deny_maintenance_periods MutableSequence[google.cloud.sqladmin_v1.types.DenyMaintenancePeriod]
Deny maintenance periods
insights_config google.cloud.sqladmin_v1.types.InsightsConfig
Insights configuration, for now relevant only for Postgres.
password_validation_policy google.cloud.sqladmin_v1.types.PasswordValidationPolicy
The local user password validation policy of the instance.
sql_server_audit_config google.cloud.sqladmin_v1.types.SqlServerAuditConfig
SQL Server specific audit configuration.
edition google.cloud.sqladmin_v1.types.Settings.Edition
Optional. The edition type of the Cloud SQL instance.
connector_enforcement google.cloud.sqladmin_v1.types.Settings.ConnectorEnforcement
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.
deletion_protection_enabled google.protobuf.wrappers_pb2.BoolValue
Configuration to protect against accidental instance deletion.
time_zone str
Server timezone, relevant only for Cloud SQL for SQL Server.
advanced_machine_features google.cloud.sqladmin_v1.types.AdvancedMachineFeatures
Specifies advanced machine configuration for the instances relevant only for SQL Server.
data_cache_config google.cloud.sqladmin_v1.types.DataCacheConfig
Configuration for data cache.
replication_lag_max_seconds google.protobuf.wrappers_pb2.Int32Value
Optional. Configuration value for recreation of replica after certain replication lag
enable_google_ml_integration google.protobuf.wrappers_pb2.BoolValue
Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for MySQL and Cloud SQL for PostgreSQL instances.
enable_dataplex_integration google.protobuf.wrappers_pb2.BoolValue
Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated.
retain_backups_on_delete google.protobuf.wrappers_pb2.BoolValue
Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
data_disk_provisioned_iops int
Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types. This field is a member of oneof_ _data_disk_provisioned_iops.
data_disk_provisioned_throughput int
Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types. This field is a member of oneof_ _data_disk_provisioned_throughput.
connection_pool_config google.cloud.sqladmin_v1.types.ConnectionPoolConfig
Optional. The managed connection pooling configuration for the instance. This field is a member of oneof_ _connection_pool_config.
final_backup_config google.cloud.sqladmin_v1.types.FinalBackupConfig
Optional. The final backup configuration for the instance. This field is a member of oneof_ _final_backup_config.
read_pool_auto_scale_config google.cloud.sqladmin_v1.types.ReadPoolAutoScaleConfig
Optional. The read pool auto-scale configuration for the instance. This field is a member of oneof_ _read_pool_auto_scale_config.
accelerated_replica_mode google.protobuf.wrappers_pb2.BoolValue
Optional. Whether the replica is in accelerated mode. This feature is in private preview and requires allowlisting to take effect.
auto_upgrade_enabled bool
Optional. Cloud SQL for MySQL auto-upgrade configuration. When this parameter is set to true, auto-upgrade is enabled for MySQL 8.0 minor versions. The MySQL version must be 8.0.35 or higher. This field is a member of oneof_ _auto_upgrade_enabled.
entraid_config google.cloud.sqladmin_v1.types.SqlServerEntraIdConfig
Optional. The Microsoft Entra ID configuration for the SQL Server instance.
data_api_access google.cloud.sqladmin_v1.types.Settings.DataApiAccess
This parameter controls whether to allow using ExecuteSql API to connect to the instance. Not allowed by default. This field is a member of oneof_ _data_api_access.
performance_capture_config google.cloud.sqladmin_v1.types.PerformanceCaptureConfig
Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations.

Classes

ConnectorEnforcement

ConnectorEnforcement(value)

The options for enforcing Cloud SQL connectors in the instance.

DataApiAccess

DataApiAccess(value)

ExecuteSql API's access to the instance.

Edition

Edition(value)

The list of Cloud SQL editions available to users.

SqlActivationPolicy

SqlActivationPolicy(value)

Specifies when the instance is activated.

UserLabelsEntry

UserLabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.
mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.