terraform-azurerm-avm-res-cache-redis

This module implements the AVM version of the Azure Cache for Redis and supporting resources. It includes the standard AVM interfaces.

[!IMPORTANT] As the overall AVM framework is not GA (generally available) yet - the CI framework and test automation is not fully functional and implemented across all supported languages yet - breaking changes are expected, and additional customer feedback is yet to be gathered and incorporated. Hence, modules MUST NOT be published at version 1.0.0 or higher at this time.

All module MUST be published as a pre-release version (e.g., 0.1.0, 0.1.1, 0.2.0, etc.) until the AVM framework becomes GA.

However, it is important to note that this DOES NOT mean that the modules cannot be consumed and utilized. They CAN be leveraged in all types of environments (dev, test, prod etc.). Consumers can treat them just like any other IaC module and raise issues or feature requests against them as they learn from the usage of the module. Consumers should also read the release notes for each version, if considering updating to a more recent version of a module to see if there are any considerations or breaking changes etc.

Requirements

The following requirements are needed by this module:

• terraform (~> 1.9)

• azapi (~> 2.0)

• azurerm (~> 4.0)

• modtm (~> 0.3)

• random (~> 3.5)

Resources

The following resources are used by this module:

• azurerm_management_lock.this (resource)
• azurerm_monitor_diagnostic_setting.this (resource)
• azurerm_private_endpoint.this_managed_dns_zone_groups (resource)
• azurerm_private_endpoint.this_unmanaged_dns_zone_groups (resource)
• azurerm_private_endpoint_application_security_group_association.this (resource)
• azurerm_redis_cache.this (resource)
• azurerm_redis_cache_access_policy.this (resource)
• azurerm_redis_cache_access_policy_assignment.this (resource)
• azurerm_redis_firewall_rule.this (resource)
• azurerm_redis_linked_server.this (resource)
• azurerm_role_assignment.this (resource)
• modtm_telemetry.telemetry (resource)
• random_uuid.telemetry (resource)
• azapi_resource.this (data source)
• azurerm_client_config.telemetry (data source)
• modtm_module_source.telemetry (data source)

Required Inputs

The following input variables are required:

location

Description: The Azure region where this and supporting resources should be deployed.

Type: string

name

Description: The name of the this resource.

Type: string

resource_group_name

Description: The resource group where the resources will be deployed.

Type: string

Optional Inputs

The following input variables are optional (have default values):

access_keys_authentication_enabled

Description: (Optional) - Whether access key authentication is enabled? Defaults to true. active_directory_authentication_enabled must be set to true to disable access key authentication.

Type: bool

Default: null

cache_access_policies

Description: A map of objects describing one or more Redis cache access policies.

• <map key> - The map key is deliberately arbitrary to avoid issues where map keys may be unknown at plan time.
  • name - (Required) - The name string of the Redis Cache Access Policy. Changing this forces a new policy to be created.
  • permissions - (Required) - A string describing the permissions to be assigned to this Redis Cache Access Policy. Changing this forces a new policy to be created.

Example Input:

cache_access_policies = {
  example_policy = {
    name = "example policy"
    permissions = "+@read +@connection +cluster|info"
  }
}

Type:

map(object({
    name        = string
    permissions = string
  }))

Default: {}

cache_access_policy_assignments

Description: A map of objects defining one or more Redis Cache access policy assignments.

• <map key> - The map key is deliberately arbitrary to avoid issues where map keys may be unknown at plan time.
  • name - (Required) - The name of the Redis Cache Access Policy Assignment. Changing this forces a new policy assignment to be created.
  • access_policy_name - (Required) - The name of the Access Policy to be assigned. Changing this forces a new policy assignment to be created.
  • object_id - (Required) - The principal ID to be assigned to the Access Policy. Changing this forces a new policy assignment to be created.
  • object_id_alias - (Required) - The alias of the principal ID. User-Friendly name for object ID. Also represents the username for token-based authentication. Changing this forces a new policy assignment to be created.

Example Input:

cache_access_policy_assignments = {
  example_policy_assignment = {
    name = "example_assignment"
    access_policy_name = "Data Contributor"
    object_id = data.azurerm_client_config.test.object_id
    object_policy_alias = "ServicePrincipal"
  }
}

Type:

map(object({
    name               = string
    access_policy_name = string
    object_id          = string
    object_id_alias    = string
  }))

Default: {}

cache_firewall_rules

Description: A map of objects defining one or more Redis Cache firewall rules.

• <map key> - The map key is deliberately arbitrary to avoid issues where map keys may be unknown at plan time.
  • name - (Required) - The name for the firewall rule
  • start_ip - (Required) - The starting IP Address for clients that are allowed to access the Redis Cache.
  • end_ip - (Required) - The ending IP Address for clients that are allowed to access the Redis Cache.

Example Input:

cache_firewall_rules = {
  rule_1 = {
    name = "thisRule"
    start_ip = "10.0.0.1"
    end_ip = "10.0.0.5"
  }
}

Type:

map(object({
    name     = string
    start_ip = string
    end_ip   = string
  }))

Default: {}

capacity

Description: (Required) - The size of the Redis Cache to deploy. Valid values for Basic and Standard skus are 0-6, and for the premium sku is 1-5

Type: number

Default: 2

diagnostic_settings

Description: A map of diagnostic settings to create on the Key Vault. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.

• name - (Optional) The name of the diagnostic setting. One will be generated if not set, however this will not be unique if you want to create multiple diagnostic setting resources.
• log_categories - (Optional) A set of log categories to send to the log analytics workspace. Defaults to [].
• log_groups - (Optional) A set of log groups to send to the log analytics workspace. Defaults to ["allLogs"].
• metric_categories - (Optional) A set of metric categories to send to the log analytics workspace. Defaults to ["AllMetrics"].
• log_analytics_destination_type - (Optional) The destination type for the diagnostic setting. Possible values are Dedicated and AzureDiagnostics. Defaults to Dedicated.
• workspace_resource_id - (Optional) The resource ID of the log analytics workspace to send logs and metrics to.
• storage_account_resource_id - (Optional) The resource ID of the storage account to send logs and metrics to.
• event_hub_authorization_rule_resource_id - (Optional) The resource ID of the event hub authorization rule to send logs and metrics to.
• event_hub_name - (Optional) The name of the event hub. If none is specified, the default event hub will be selected.
• marketplace_partner_resource_id - (Optional) The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic LogsLogs.

Example Input:

diagnostic_settings = {
  diag_setting_1 = {
    name                           = "diagSetting1"
    log_groups                     = ["allLogs"]
    metric_categories              = ["AllMetrics"]
    log_analytics_destination_type = null
    workspace_resource_id          = azurerm_log_analytics_workspace.this_workspace.id
  }
}

Type:

map(object({
    name                                     = optional(string, null)
    log_categories                           = optional(set(string), [])
    log_groups                               = optional(set(string), ["allLogs"])
    metric_categories                        = optional(set(string), ["AllMetrics"])
    log_analytics_destination_type           = optional(string, "Dedicated")
    workspace_resource_id                    = optional(string, null)
    storage_account_resource_id              = optional(string, null)
    event_hub_authorization_rule_resource_id = optional(string, null)
    event_hub_name                           = optional(string, null)
    marketplace_partner_resource_id          = optional(string, null)
  }))

Default: {}

enable_non_ssl_port

Description: (Optional) - Enable the non-ssl port 6379. Disabled by default

Type: bool

Default: false

enable_telemetry

Description: This variable controls whether or not telemetry is enabled for the module.
For more information see https://aka.ms/avm/telemetryinfo.
If it is set to false, then no telemetry will be collected.

Type: bool

Default: false

linked_redis_caches

Description: A map of objects defining one or linked Redis Cache instances to use as secondaries.

• <map key> - The map key is deliberately arbitrary to avoid issues where map keys may be unknown at plan time.
  • linked_redis_cache_resource_id = (Required) - The Azure resource ID of the Redis Cache that is being linked. Changing this forces a new Redis to be created.
  • linked_redis_cache_location = (Required) - The location value for the Redis Cache that is being linked. Changing this forces a new Redis to be created.
  • server_role - (Required) - The role of the linked Redis Cache. Possible values are Primary and Secondary. Changing this forces a new Redis to be created.

Example Input:

linked_redis_caches = {
  linked_cache_1 = {
    linked_redis_cache_resource_id = azurerm_redis_cache.example_secondary.id
    linked_redis_cache_location = azurerm_redis_cache.example_secondary.location
    server_role = "Secondary"
  }
}

Type:

map(object({
    linked_redis_cache_resource_id = string
    linked_redis_cache_location    = string
    server_role                    = string
  }))

Default: {}

lock

Description: Controls the Resource Lock configuration for this resource. The following properties can be specified:

• kind - (Required) The type of lock. Possible values are \"CanNotDelete\" and \"ReadOnly\".
• name - (Optional) The name of the lock. If not specified, a name will be generated based on the kind value. Changing this forces the creation of a new resource.

Example Input:

lock = {
  kind = "CanNotDelete"
  name = "Delete"
}

Type:

object({
    kind = string
    name = optional(string, null)
  })

Default: null

managed_identities

Description: Controls the Managed Identity configuration on this resource. The following properties can be specified:

• system_assigned - (Optional) Specifies if the System Assigned Managed Identity should be enabled.
• user_assigned_resource_ids - (Optional) Specifies a list of User Assigned Managed Identity resource IDs to be assigned to this resource.

Example Input:

managed_identities = {
  system_assigned = true
}

Type:

object({
    system_assigned            = optional(bool, false)
    user_assigned_resource_ids = optional(set(string), [])
  })

Default: {}

minimum_tls_version

Description: (Optional) - The minimum TLS version. Possible values are 1.0, 1.1, and 1.2. Defaults to 1.2

Type: string

Default: "1.2"

patch_schedule

Description: A set of objects describing the following patch schedule attributes. If no value is configured defaults to an empty set.

• day_of_week - (Optional) - A string value for the day of week to start the patch schedule. Valid values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday.
• maintenance_window - (Optional) - A string value following the ISO 8601 timespan system which specifies the length of time the Redis Cache can be updated from the start hour. Defaults to PT5H.
• start_hour_utc - (Optional) - The start hour for maintenance in UTC. Possible values range from 0-23. Defaults to 0.

Example Input:

patch_schedule = [
  {
    day_of_week = "Friday"
    maintenance_window = "PT5H"
    start_hour_utc = 23
  }
]

Type:

set(object({
    day_of_week        = optional(string, "Saturday")
    maintenance_window = optional(string, "PT5H")
    start_hour_utc     = optional(number, 0)
  }))

Default: []

private_endpoints

Description: A map of private endpoints to create on this resource. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.

• name - (Optional) The name of the private endpoint. One will be generated if not set.
• role_assignments - (Optional) A map of role assignments to create on the private endpoint. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time. See var.role_assignments for more information.
• lock - (Optional) The lock level to apply to the private endpoint. Default is None. Possible values are None, CanNotDelete, and ReadOnly.
• tags - (Optional) A mapping of tags to assign to the private endpoint.
• subnet_resource_id - The resource ID of the subnet to deploy the private endpoint in.
• private_dns_zone_group_name - (Optional) The name of the private DNS zone group. One will be generated if not set.
• private_dns_zone_resource_ids - (Optional) A set of resource IDs of private DNS zones to associate with the private endpoint. If not set, no zone groups will be created and the private endpoint will not be associated with any private DNS zones. DNS records must be managed external to this module.
• application_security_group_resource_ids - (Optional) A map of resource IDs of application security groups to associate with the private endpoint. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.
• private_service_connection_name - (Optional) The name of the private service connection. One will be generated if not set.
• network_interface_name - (Optional) The name of the network interface. One will be generated if not set.
• location - (Optional) The Azure location where the resources will be deployed. Defaults to the location of the resource group.
• resource_group_name - (Optional) The resource group where the resources will be deployed. Defaults to the resource group of this resource.
• ip_configurations - (Optional) A map of IP configurations to create on the private endpoint. If not specified the platform will create one. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.
  • name - The name of the IP configuration.
  • private_ip_address - The private IP address of the IP configuration.

Example Input:

private_endpoints = {
  endpoint1 = {
    subnet_resource_id            = azurerm_subnet.endpoint.id
    private_dns_zone_group_name   = "private-dns-zone-group"
    private_dns_zone_resource_ids = [azurerm_private_dns_zone.this.id]
  }
}

Type:

map(object({
    name = optional(string, null)
    role_assignments = optional(map(object({
      role_definition_id_or_name             = string
      principal_id                           = string
      description                            = optional(string, null)
      skip_service_principal_aad_check       = optional(bool, false)
      condition                              = optional(string, null)
      condition_version                      = optional(string, null)
      delegated_managed_identity_resource_id = optional(string, null)
      principal_type                         = optional(string, null)
    })), {})
    lock = optional(object({
      kind = string
      name = optional(string, null)
    }), null)
    tags                                    = optional(map(string), null)
    subnet_resource_id                      = string
    private_dns_zone_group_name             = optional(string, "default")
    private_dns_zone_resource_ids           = optional(set(string), [])
    application_security_group_associations = optional(map(string), {})
    private_service_connection_name         = optional(string, null)
    network_interface_name                  = optional(string, null)
    location                                = optional(string, null)
    resource_group_name                     = optional(string, null)
    ip_configurations = optional(map(object({
      name               = string
      private_ip_address = string
    })), {})
  }))

Default: {}

private_endpoints_manage_dns_zone_group

Description: Default to true. Whether to manage private DNS zone groups with this module. If set to false, you must manage private DNS zone groups externally, e.g. using Azure Policy.

Type: bool

Default: true

private_static_ip_address

Description: (Optional) - The static IP Address to assign to the Redis Cache when hosted inside a virtual network. Configuring this value implies that the subnet_resource_id value has been set.

Type: string

Default: null

public_network_access_enabled

Description: (Optional) - Identifies whether the public network access is allowed for the Redis Cache. True means that both public and private endpoint access is allowed. False limits access to the private endpoint only. Defaults to True.

Type: bool

Default: true

redis_configuration

Description: Describes redis configuration block.

• aof_backup_enabled = (Optional) Enable or disable AOF persistence for this Redis Cache. Defaults to false. Note: aof_backup_enabled can only be set when SKU is Premium.
• aof_storage_connection_string_0 = (Optional) First Storage Account connection string for AOF persistence.
• aof_storage_connection_string_1 = (Optional) Second Storage Account connection string for AOF persistence.
• enable_authentication = (Optional) If set to false, the Redis instance will be accessible without authentication. Defaults to true.
• active_directory_authentication_enabled = (Optional) Enable Microsoft Entra (AAD) authentication. Defaults to false.
• maxmemory_reserved = (Optional) Value in megabytes reserved for non-cache usage e.g. failover. Defaults are shown below.
• maxmemory_delta = (Optional) The max-memory delta for this Redis instance. Defaults are shown below.
• maxmemory_policy = (Optional) How Redis will select what to remove when maxmemory is reached. Defaults to volatile-lru.
• data_persistence_authentication_method = (Optional) Preferred auth method to communicate to storage account used for data persistence. Possible values are SAS and ManagedIdentity. Defaults to SAS.
• maxfragmentationmemory_reserved = (Optional) Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below.
• rdb_backup_enabled = (Optional) Is Backup Enabled? Only supported on Premium SKUs. Defaults to false. Note - If rdb_backup_enabled set to true, rdb_storage_connection_string must also be set.
• rdb_backup_frequency = (Optional) The Backup Frequency in Minutes. Only supported on Premium SKUs. Possible values are: 15, 30, 60, 360, 720 and 1440.
• rdb_backup_max_snapshot_count = (Optional) The maximum number of snapshots to create as a backup. Only supported for Premium SKUs.
• rdb_storage_connection_string = (Optional) The Connection String to the Storage Account. Only supported for Premium SKUs. In the format: DefaultEndpointsProtocol=https;BlobEndpoint=${azurerm_storage_account.example.primary_blob_endpoint};AccountName=${azurerm_storage_account.example.name};AccountKey=${azurerm_storage_account.example.primary_access_key}.
• storage_account_subscription_resource_id = (Optional) The ID of the Subscription containing the Storage Account.
• notify_keyspace_events = (Optional) Keyspace notifications allows clients to subscribe to Pub/Sub channels in order to receive events affecting the Redis data set in some way.

Example Input:

redis_configuration = {
  maxmemory_reserved = 10
  maxmemory_delta    = 2
  maxmemory_policy   = "allkeys-lru"
}

Type:

object({
    aof_backup_enabled                       = optional(bool)
    aof_storage_connection_string_0          = optional(string)
    aof_storage_connection_string_1          = optional(string)
    enable_authentication                    = optional(bool)
    active_directory_authentication_enabled  = optional(bool)
    maxmemory_reserved                       = optional(number)
    maxmemory_delta                          = optional(number)
    maxfragmentationmemory_reserved          = optional(number)
    maxmemory_policy                         = optional(string)
    data_persistence_authentication_method   = optional(string) #TODO: research the managed identity vs. SAS key and determine level of effort required to default to ManagedIdentity as the more secure option, and review what happens if data persistence is not enabled.
    rdb_backup_enabled                       = optional(bool)   #TODO: Research if we want backups to be true. Given this is cache, probably not required.
    rdb_backup_frequency                     = optional(number)
    rdb_backup_max_snapshot_count            = optional(number)
    rdb_storage_connection_string            = optional(string)
    storage_account_subscription_resource_id = optional(string)
    notify_keyspace_events                   = optional(string)
  })

Default: {}

redis_version

Description: (Optional) Redis version. Only major version needed. Valid values are: 4 and 6

Type: number

Default: null

replicas_per_master

Description: (Optional) - The quantity of replicas to create per master for this Redis Cache.

Type: number

Default: null

replicas_per_primary

Description: (Optional) Quantity of replicas to create per primary for this Redis Cache.

Type: number

Default: null

role_assignments

Description: A map of role assignments to create on the . The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.

• role_definition_id_or_name - The ID or name of the role definition to assign to the principal.
• principal_id - The ID of the principal to assign the role to.
• description - (Optional) The description of the role assignment.
• skip_service_principal_aad_check - (Optional) If set to true, skips the Azure Active Directory check for the service principal in the tenant. Defaults to false.
• condition - (Optional) The condition which will be used to scope the role assignment.
• condition_version - (Optional) The version of the condition syntax. Leave as null if you are not using a condition, if you are then valid values are '2.0'.
• delegated_managed_identity_resource_id - (Optional) The delegated Azure Resource Id which contains a Managed Identity. Changing this forces a new resource to be created. This field is only used in cross-tenant scenario.
• principal_type - (Optional) The type of the principal_id. Possible values are User, Group and ServicePrincipal. It is necessary to explicitly set this attribute when creating role assignments if the principal creating the assignment is constrained by ABAC rules that filters on the PrincipalType attribute.

Note: only set skip_service_principal_aad_check to true if you are assigning a role to a service principal.

Example Input:

role_assignments = {
  deployment_user_contributor = {
    role_definition_id_or_name = "Contributor"
    principal_id               = data.azurerm_client_config.current.client_id
  }
}

Type:

map(object({
    role_definition_id_or_name             = string
    principal_id                           = string
    description                            = optional(string, null)
    skip_service_principal_aad_check       = optional(bool, false)
    condition                              = optional(string, null)
    condition_version                      = optional(string, null)
    delegated_managed_identity_resource_id = optional(string, null)
    principal_type                         = optional(string, null)
  }))

Default: {}

shard_count

Description: (Optional) - Only available when using the Premium SKU. The number of shards to create on the Redis Cluster.

Type: number

Default: null

sku_name

Description: (Required) - The Redis SKU to use. Possible values are Basic, Standard, and Premium. Note: Downgrading the sku will force new resource creation.

Type: string

Default: "Premium"

subnet_resource_id

Description: (Optional) - Only available when using the Premium SKU. The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.

Type: string

Default: null

tags

Description: (Optional) Tags of the resource.

Type: map(string)

Default: null

tenant_settings

Description: (Optional) A mapping of tenant settings to assign to the resource.

Type: map(string)

Default: {}

zones

Description: (Optional) - Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.

Type: list(string)

Default:

[
  "1",
  "2",
  "3"
]

Outputs

The following outputs are exported:

name

Description: The name of the redis resource

private_endpoints

Description: A map of private endpoints. The map key is the supplied input to var.private_endpoints. The map value is the entire azurerm_private_endpoint resource.

resource

Description: This is the full output for the resource.

resource_id

Description: The resource id of the redis cache resource.

system_assigned_mi_principal_id

Description: The resource id for the system managed identity principal id.

Modules

No modules.

Data Collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.

 
 {
  "workingFolder": "packages",
  "packages": [
    // packages defined earlier
    {
      "name": "avm-terraform/cache-redis",
      "version": "0.4.0"
    }
  ]
}