terraform-google-sql for MSSQL Server

The following dependency must be available for SQL Server module:

Usage

Functional examples are included in the examples directory. If you want to create an instance with failover replica and manage lifecycle of primary and secondary instance lifecycle using this module follow example in mssql-failover-replica

Basic usage of this module is as follows:

Create simple Postgresql instance with read replica

module "mssql" {
  source  = "terraform-google-modules/sql-db/google//modules/mssql"
  version = "~> 26.2"

  name                 = var.name
  random_instance_name = true
  project_id           = var.project_id
  user_name            = "simpleuser"
  user_password        = "foobar"

  deletion_protection = false

  sql_server_audit_config = var.sql_server_audit_config
}

Inputs

Name	Description	Type	Default	Required
activation_policy	The activation policy for the Cloud SQL instance. Can be either `ALWAYS`, `NEVER` or `ON_DEMAND`.	`string`	`"ALWAYS"`	no
active_directory_config	Active domain that the SQL instance will join.	`map(string)`	`{}`	no
additional_databases	A list of databases to be created in your cluster	list(object({ name = string charset = string collation = string }))	`[]`	no
additional_users	A list of users to be created in your cluster. A random password would be set for the user if the `random_password` variable is set.	list(object({ name = string password = string random_password = bool }))	`[]`	no
availability_type	The availability type for the Cloud SQL instance.This is only used to set up high availability for the MSSQL instance. Can be either `ZONAL` or `REGIONAL`.	`string`	`"ZONAL"`	no
backup_configuration	The database backup configuration.	object({ binary_log_enabled = bool enabled = bool point_in_time_recovery_enabled = bool start_time = string transaction_log_retention_days = string retained_backups = number retention_unit = string })	{ "binary_log_enabled": null, "enabled": false, "point_in_time_recovery_enabled": null, "retained_backups": null, "retention_unit": null, "start_time": null, "transaction_log_retention_days": null }	no
connector_enforcement	Enforce that clients use the connector library	`bool`	`false`	no
create_timeout	The optional timeout that is applied to limit long database creates.	`string`	`"30m"`	no
data_cache_enabled	Whether data cache is enabled for the instance. Defaults to false. Feature is only available for ENTERPRISE_PLUS tier and supported database_versions	`bool`	`false`	no
database_flags	The database flags for the Cloud SQL. See more details	list(object({ name = string value = string }))	`[]`	no
database_version	The database version to use: SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, or SQLSERVER_2017_WEB	`string`	`"SQLSERVER_2017_STANDARD"`	no
db_charset	The charset for the default database	`string`	`""`	no
db_collation	The collation for the default database. Example: 'en_US.UTF8'	`string`	`""`	no
db_name	The name of the default database to create	`string`	`"default"`	no
delete_timeout	The optional timeout that is applied to limit long database deletes.	`string`	`"30m"`	no
deletion_protection	Used to block Terraform from deleting a SQL Instance.	`bool`	`true`	no
deletion_protection_enabled	Enables protection of an instance from accidental deletion protection across all surfaces (API, gcloud, Cloud Console and Terraform).	`bool`	`false`	no
deny_maintenance_period	The Deny Maintenance Period fields to prevent automatic maintenance from occurring during a 90-day time period. List accepts only one value. See more details	list(object({ end_date = string start_date = string time = string }))	`[]`	no
disk_autoresize	Configuration to increase storage size.	`bool`	`true`	no
disk_autoresize_limit	The maximum size to which storage can be auto increased.	`number`	`0`	no
disk_size	The disk size for the Cloud SQL instance.	`number`	`10`	no
disk_type	The disk type for the Cloud SQL instance.	`string`	`"PD_SSD"`	no
edition	The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS.	`string`	`null`	no
enable_dataplex_integration	Enable database Dataplex integration	`bool`	`false`	no
enable_default_db	Enable or disable the creation of the default database	`bool`	`true`	no
enable_default_user	Enable or disable the creation of the default user	`bool`	`true`	no
encryption_key_name	The full path to the encryption key used for the CMEK disk encryption	`string`	`null`	no
follow_gae_application	A Google App Engine application whose zone to remain in. Must be in the same region as this instance.	`string`	`null`	no
insights_config	The insights_config settings for the database.	object({ query_plans_per_minute = optional(number, 5) query_string_length = optional(number, 1024) record_application_tags = optional(bool, false) record_client_address = optional(bool, false) })	`null`	no
instance_type	The type of the instance. The supported values are SQL_INSTANCE_TYPE_UNSPECIFIED, CLOUD_SQL_INSTANCE, ON_PREMISES_INSTANCE and READ_REPLICA_INSTANCE. Set to READ_REPLICA_INSTANCE when primary_instance_name is provided	`string`	`"CLOUD_SQL_INSTANCE"`	no
ip_configuration	The ip configuration for the Cloud SQL instances.	object({ authorized_networks = optional(list(map(string)), []) ipv4_enabled = optional(bool) private_network = optional(string) allocated_ip_range = optional(string) ssl_mode = optional(string) })	{ "allocated_ip_range": null, "authorized_networks": [], "ipv4_enabled": true, "private_network": null, "ssl_mode": null }	no
maintenance_version	The current software version on the instance. This attribute can not be set during creation. Refer to available_maintenance_versions attribute to see what maintenance_version are available for upgrade. When this attribute gets updated, it will cause an instance restart. Setting a maintenance_version value that is older than the current one on the instance will be ignored	`string`	`null`	no
maintenance_window_day	The day of week (1-7) for the Cloud SQL maintenance.	`number`	`1`	no
maintenance_window_hour	The hour of day (0-23) maintenance window for the Cloud SQL maintenance.	`number`	`23`	no
maintenance_window_update_track	The update track of maintenance window for the Cloud SQL maintenance.Can be either `canary` or `stable`.	`string`	`"canary"`	no
master_instance_name	Name of the master instance if this is a failover replica. Required for creating failover replica instance. Not needed for master instance. When removed, next terraform apply will promote this failover failover replica instance as master instance	`string`	`null`	no
module_depends_on	List of modules or resources this module depends on.	`list(any)`	`[]`	no
name	The name of the Cloud SQL instance	`string`	n/a	yes
pricing_plan	The pricing plan for the Cloud SQL instance.	`string`	`"PER_USE"`	no
project_id	The project ID to manage the Cloud SQL resources	`string`	n/a	yes
random_instance_name	Sets random suffix at the end of the Cloud SQL resource name	`bool`	`false`	no
region	The region of the Cloud SQL resources	`string`	`"us-central1"`	no
retain_backups_on_delete	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.	`bool`	`false`	no
root_password	MSSERVER password for the root user. If not set, a random one will be generated and available in the root_password output variable.	`string`	`""`	no
secondary_zone	The preferred zone for the read replica instance, it should be something like: `us-central1-a`, `us-east1-c`.	`string`	`null`	no
sql_server_audit_config	SQL server audit config settings.	`map(string)`	`{}`	no
tier	The tier for the Cloud SQL instance.	`string`	`"db-custom-2-3840"`	no
time_zone	The time zone for Cloud SQL instance.	`string`	`null`	no
update_timeout	The optional timeout that is applied to limit long database updates.	`string`	`"30m"`	no
user_labels	The key/value labels for the Cloud SQL instances.	`map(string)`	`{}`	no
user_name	The name of the default user	`string`	`"default"`	no
user_password	The password for the default user. If not set, a random one will be generated and available in the generated_user_password output variable.	`string`	`""`	no
zone	The zone for the Cloud SQL instance.	`string`	`null`	no

Outputs

Name	Description
additional_users	List of maps of additional users and passwords
apphub_service_uri	Service URI in CAIS style to be used by Apphub.
generated_user_password	The auto generated default user password if not input password was provided
instance_address	The IPv4 addesses assigned for the master instance
instance_connection_name	The connection name of the master instance to be used in connection strings
instance_first_ip_address	The first IPv4 address of the addresses assigned.
instance_name	The instance name for the master instance
instance_self_link	The URI of the master instance
instance_server_ca_cert	The CA certificate information used to connect to the SQL instance via SSL
instance_service_account_email_address	The service account email address assigned to the master instance
primary	The `google_sql_database_instance` resource representing the primary instance
private_address	The private IP address assigned for the master instance
root_password	MSSERVER password for the root user. If not set, a random one will be generated and available in the root_password output variable.

Requirements

Installation Dependencies

Terraform >= 1.3.0
terraform-provider-google plugin v5.12+
Terraform Provider Beta for GCP plugin v5.12+