Settings

import type { Settings } from "https://googleapis.deno.dev/v1/sqladmin:v1.ts";

Database instance settings.

interface Settings {

activationPolicy?:

| "SQL_ACTIVATION_POLICY_UNSPECIFIED"

| "ALWAYS"

| "NEVER"

| "ON_DEMAND";

activeDirectoryConfig?: SqlActiveDirectoryConfig;

advancedMachineFeatures?: AdvancedMachineFeatures;

authorizedGaeApplications?: string[];

availabilityType?: "SQL_AVAILABILITY_TYPE_UNSPECIFIED" | "ZONAL" | "REGIONAL";

backupConfiguration?: BackupConfiguration;

collation?: string;

connectorEnforcement?: "CONNECTOR_ENFORCEMENT_UNSPECIFIED" | "NOT_REQUIRED" | "REQUIRED";

crashSafeReplicationEnabled?: boolean;

databaseFlags?: DatabaseFlags[];

databaseReplicationEnabled?: boolean;

dataCacheConfig?: DataCacheConfig;

dataDiskSizeGb?: bigint;

dataDiskType?:

| "SQL_DATA_DISK_TYPE_UNSPECIFIED"

| "PD_SSD"

| "PD_HDD"

| "OBSOLETE_LOCAL_SSD";

deletionProtectionEnabled?: boolean;

denyMaintenancePeriods?: DenyMaintenancePeriod[];

edition?: "EDITION_UNSPECIFIED" | "ENTERPRISE" | "ENTERPRISE_PLUS";

enableGoogleMlIntegration?: boolean;

insightsConfig?: InsightsConfig;

ipConfiguration?: IpConfiguration;

kind?: string;

locationPreference?: LocationPreference;

maintenanceWindow?: MaintenanceWindow;

passwordValidationPolicy?: PasswordValidationPolicy;

pricingPlan?: "SQL_PRICING_PLAN_UNSPECIFIED" | "PACKAGE" | "PER_USE";

replicationType?: "SQL_REPLICATION_TYPE_UNSPECIFIED" | "SYNCHRONOUS" | "ASYNCHRONOUS";

settingsVersion?: bigint;

sqlServerAuditConfig?: SqlServerAuditConfig;

storageAutoResize?: boolean;

storageAutoResizeLimit?: bigint;

tier?: string;

timeZone?: string;

userLabels?: {

[key: string]: string;

};

}

§Properties

activationPolicy?: "SQL_ACTIVATION_POLICY_UNSPECIFIED" | "ALWAYS" | "NEVER" | "ON_DEMAND"

[src]

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.

activeDirectoryConfig?: SqlActiveDirectoryConfig

[src]

Active Directory configuration, relevant only for Cloud SQL for SQL Server.

advancedMachineFeatures?: AdvancedMachineFeatures

[src]

Specifies advance machine configuration for the instance relevant only for SQL Server.

authorizedGaeApplications?: string[]

[src]

The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.

availabilityType?: "SQL_AVAILABILITY_TYPE_UNSPECIFIED" | "ZONAL" | "REGIONAL"

[src]

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.

backupConfiguration?: BackupConfiguration

[src]

The daily backup configuration for the instance.

collation?: string

[src]

The name of server Instance collation.

connectorEnforcement?: "CONNECTOR_ENFORCEMENT_UNSPECIFIED" | "NOT_REQUIRED" | "REQUIRED"

[src]

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.

crashSafeReplicationEnabled?: boolean

[src]

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.

databaseFlags?: DatabaseFlags[]

[src]

The database flags passed to the instance at startup.

databaseReplicationEnabled?: boolean

[src]

Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.

dataCacheConfig?: DataCacheConfig

[src]

Configuration for data cache.

dataDiskSizeGb?: bigint

[src]

The size of data disk, in GB. The data disk size minimum is 10GB.

dataDiskType?: "SQL_DATA_DISK_TYPE_UNSPECIFIED" | "PD_SSD" | "PD_HDD" | "OBSOLETE_LOCAL_SSD"

[src]

The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.

deletionProtectionEnabled?: boolean

[src]

Configuration to protect against accidental instance deletion.

denyMaintenancePeriods?: DenyMaintenancePeriod[]

[src]

Deny maintenance periods

edition?: "EDITION_UNSPECIFIED" | "ENTERPRISE" | "ENTERPRISE_PLUS"

[src]

Optional. The edition of the instance.

enableGoogleMlIntegration?: boolean

[src]

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 PostgreSQL instances.

insightsConfig?: InsightsConfig

[src]

Insights configuration, for now relevant only for Postgres.

ipConfiguration?: IpConfiguration

[src]

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.

kind?: string

[src]

This is always sql#settings.

locationPreference?: LocationPreference

[src]

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.

maintenanceWindow?: MaintenanceWindow

[src]

The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.

passwordValidationPolicy?: PasswordValidationPolicy

[src]

The local user password validation policy of the instance.

pricingPlan?: "SQL_PRICING_PLAN_UNSPECIFIED" | "PACKAGE" | "PER_USE"

[src]

The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances.

replicationType?: "SQL_REPLICATION_TYPE_UNSPECIFIED" | "SYNCHRONOUS" | "ASYNCHRONOUS"

[src]

The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. (Deprecated) This property was only applicable to First Generation instances.

settingsVersion?: bigint

[src]

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.

sqlServerAuditConfig?: SqlServerAuditConfig

[src]

SQL Server specific audit configuration.

storageAutoResize?: boolean

[src]

Configuration to increase storage size automatically. The default value is true.

storageAutoResizeLimit?: bigint

[src]

The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

tier?: string

[src]

The tier (or machine type) for this instance, for example db-custom-1-3840. WARNING: Changing this restarts the instance.

timeZone?: string

[src]

Server timezone, relevant only for Cloud SQL for SQL Server.

userLabels?: {

[key: string]: string;

}

[src]

User-provided labels, represented as a dictionary where each label is a single key value pair.