variables.md

Variables

variable "config" {
  type = list(object({
    # postgresql flexible server
    name                   = string
    resource_group_name    = string
    location               = string
    administrator_login    = optional(string)
    administrator_password = optional(string)
    authentication = optional(object({
      active_directory_auth_enabled = optional(bool)
      password_auth_enabled         = optional(bool)
      tenant_id                     = optional(string)
    }))
    backup_retention_days = optional(number)
    customer_managed_key = optional(object({
      key_vault_key_id                     = string
      primary_user_assigned_identity_id    = optional(string)
      geo_backup_key_vault_key_id          = optional(string)
      geo_backup_user_assigned_identity_id = optional(string)
    }))
    geo_redundant_backup_enabled = optional(bool)
    create_mode                  = optional(string)
    delegated_subnet_id          = optional(string)
    private_dns_zone_id          = optional(string)
    high_availability = optional(object({
      mode                      = string
      standby_availability_zone = optional(string)
    }))
    identity = optional(object({
      type         = string
      identity_ids = list(string)
    }))
    maintenance_window = optional(object({
      day_of_week  = optional(number)
      start_hour   = optional(number)
      start_minute = optional(number)
    }))
    point_in_time_restore_time_in_utc = optional(string)
    replication_role                  = optional(string)
    sku_name                          = optional(string)
    source_server_id                  = optional(string)
    auto_grow_enabled                 = optional(bool)
    public_network_access_enabled     = optional(bool, false)
    storage_mb                        = optional(number)
    storage_tier                      = optional(string)
    version                           = optional(number)
    zone                              = optional(string)
    tags                              = optional(map(any))

    # postgresql flexible server database
    flexible_db = optional(list(object({
      name      = string
      server_id = optional(string) # Inherited in module from parent resource
      charset   = optional(string)
      collation = optional(string)
    })), [])

    # postgresql flexible server configuration
    server_configuration = optional(list(object({
      name      = string
      server_id = optional(string) # Inherited in module from parent resource
      value     = string
    })), [])

    # postgresql flexible server active directory administrator
    server_ad_administrator = optional(list(object({
      server_name         = optional(string) # Inherited in module from parent resource
      resource_group_name = optional(string) # If not provided, inherited in module from parent resource
      object_id           = string
      tenant_id           = string
      principal_name      = string
      principal_type      = string
    })), [])

    # private endpoint
    private_endpoint = optional(list(object({
      name                = string
      resource_group_name = optional(string) # If not provided, inherited in module from parent resource
      location            = optional(string) # If not provided, inherited in module from parent resource
      subnet_id           = string
      private_service_connection = list(object({
        name                              = string
        is_manual_connection              = bool
        private_connection_resource_id    = optional(string)
        private_connection_resource_alias = optional(string)
        subresource_names                 = optional(list(string))
        request_message                   = optional(string)
      }))
      custom_network_interface_name = optional(string)
      private_dns_zone_group = optional(object({
        name                 = string
        private_dns_zone_ids = list(string)
      }))
      ip_configuration = optional(list(object({
        name               = string
        private_ip_address = string
        subresource_name   = string
        member_name        = optional(string)
      })), [])
      tags = optional(map(any)) # If not provided, inherited in module from parent resource
    })), [])

    # monitoring
    monitoring = optional(list(object({                 # Custom object for enabling diagnostic settings
      diag_name                      = optional(string) # Name of the diagnostic setting
      log_analytics_workspace_id     = optional(string)
      eventhub_name                  = optional(string)
      eventhub_authorization_rule_id = optional(string)
      categories = optional(object({
        postgre_sql_logs                        = optional(bool, true)
        postgre_sql_flex_sessions               = optional(bool, true)
        postgre_sql_flex_query_store_runtime    = optional(bool, true)
        postgre_sql_flex_query_store_wait_stats = optional(bool, true)
        postgre_sql_flex_table_stats            = optional(bool, true)
        postgre_sql_flex_database_xacts         = optional(bool, true)
        all_metrics                             = optional(bool, true)
      }))
    })), [])
  }))
}

Table with config variables

Name	Data Type	Requirement	Default Value	Comment
name	string	Required
resource_group_name	string	Required
location	string	Required
administrator_login	string	Optional
administrator_password	string	Optional
authentication	object	Optional
active_directory_auth_enabled	bool	Optional
password_auth_enabled	bool	Optional
tenant_id	string	Optional
backup_retention_days	number	Optional
customer_managed_key	object	Optional
key_vault_key_id	string	Required
primary_user_assigned_identity_id	string	Optional
geo_backup_key_vault_key_id	string	Optional
geo_backup_user_assigned_identity_id	string	Optional
geo_redundant_backup_enabled	bool	Optional
create_mode	string	Optional
delegated_subnet_id	string	Optional
private_dns_zone_id	string	Optional
high_availability	object	Optional
mode	string	Required
standby_availability_zone	string	Optional
identity	object	Optional
type	string	Required
identity_ids	list(string)	Required
maintenance_window	object	Optional
day_of_week	number	Optional
start_hour	number	Optional
start_minute	number	Optional
point_in_time_restore_time_in_utc	string	Optional
replication_role	string	Optional
sku_name	string	Optional
source_server_id	string	Optional
auto_grow_enabled	bool	Optional
public_network_access_enabled	bool	Optional	false
storage_mb	number	Optional
storage_tier	string	Optional
version	number	Optional
zone	string	Optional
tags	map(any)	Optional
flexible_db	list(object)	Optional	[]
name	string	Required
server_id	string	Optional		Inherited in module from parent resource
charset	string	Optional
collation	string	Optional
server_configuration	list(object)	Optional	[]
name	string	Required
server_id	string	Optional		Inherited in module from parent resource
value	string	Required
server_ad_administrator	list(object)	Optional	[]
server_name	string	Optional		Inherited in module from parent resource
resource_group_name	string	Optional		If not provided, inherited in module from parent resource
object_id	string	Required
tenant_id	string	Required
principal_name	string	Required
principal_type	string	Required
private_endpoint	list(object)	Optional	[]
name	string	Required
resource_group_name	string	Optional		If not provided, inherited in module from parent resource
location	string	Optional		If not provided, inherited in module from parent resource
subnet_id	string	Required
private_service_connection	list(object)	Required
name	string	Required
is_manual_connection	bool	Required
private_connection_resource_id	string	Optional
private_connection_resource_alias	string	Optional
subresource_names	list(string)	Optional
request_message	string	Optional
custom_network_interface_name	string	Optional
private_dns_zone_group	object	Optional
name	string	Required
private_dns_zone_ids	list(string)	Required
ip_configuration	list(object)	Optional	[]
name	string	Required
private_ip_address	string	Required
subresource_name	string	Required
member_name	string	Optional
tags	map(any)	Optional		If not provided, inherited in module from parent resource
monitoring	list(object)	Optional	[]	Custom object for enabling diagnostic settings
diag_name	string	Optional		Name of the diagnostic setting
log_analytics_workspace_id	string	Optional
eventhub_name	string	Optional
eventhub_authorization_rule_id	string	Optional
categories	object	Optional
postgre_sql_logs	bool	Optional	true
postgre_sql_flex_sessions	bool	Optional	true
postgre_sql_flex_query_store_runtime	bool	Optional	true
postgre_sql_flex_query_store_wait_stats	bool	Optional	true
postgre_sql_flex_table_stats	bool	Optional	true
postgre_sql_flex_database_xacts	bool	Optional	true
all_metrics	bool	Optional	true