Set by controls 5

Active controls fix these values.

• at_rest_encryption_enabledbool, set to trueWhether to enable encryption at rest
• kms_key_arnstring, set to nullThe ARN of the key that you wish to use if encrypting at rest. If not supplied, uses service managed encryption. Can be specified only if at_rest_encryption_enabled = true
• snapshot_retention_limitnumber, set to 15(Redis only) Number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them
• subnet_group_namestring, set to nullThe name of the subnet group. If create_subnet_group is true, this is the name assigned to the subnet group created. Otherwise, this is the name of an existing subnet group
• transit_encryption_enabledbool, set to trueEnable encryption in-transit

Optional 63

• apply_immediatelybool, default nullWhether any database modifications are applied immediately, or during the next maintenance window. Default is false
• auth_tokenstring, default nullThe password used to access a password protected server. Can be specified only if transit_encryption_enabled = true
• auth_token_update_strategystring, default nullStrategy to use when updating the auth_token. Valid values are SET, ROTATE, and DELETE. Defaults to ROTATE
• auto_minor_version_upgradebool, default nullSpecifies whether minor version engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window. Only supported for engine type redis and valkey and if the engine version is 6 or higher. Defaults to true
• automatic_failover_enabledbool, default nullSpecifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. If true, Multi-AZ is enabled for this replication group. If false, Multi-AZ is disabled for this replication group. Must be enabled for Redis (cluster mode enabled) replication groups
• availability_zonestring, default nullAvailability Zone for the cache cluster. If you want to create cache nodes in multi-az, use preferred_availability_zones instead
• az_modestring, default nullWhether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region. Valid values for this parameter are single-az or cross-az, default is single-az
• cluster_idstring, default ""Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource
• cluster_modestring, default nullSpecifies whether cluster mode is enabled or disabled. Valid values are enabled or disabled or compatible
• cluster_mode_enabledbool, default falseWhether to enable Redis [cluster mode https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Replication.Redis-RedisCluster.html]
• createbool, default trueDetermines whether resources will be created (affects all resources)
• create_clusterbool, default falseDetermines whether an ElastiCache cluster will be created or not
• create_parameter_groupbool, default falseDetermines whether the ElastiCache parameter group will be created or not
• create_primary_global_replication_groupbool, default falseDetermines whether an primary ElastiCache global replication group will be created
• create_replication_groupbool, default trueDetermines whether an ElastiCache replication group will be created or not
• create_secondary_global_replication_groupbool, default falseDetermines whether an secondary ElastiCache global replication group will be created
• create_security_groupbool, default trueDetermines if a security group is created
• create_subnet_groupbool, default trueDetermines whether the Elasticache subnet group will be created or not
• data_tiering_enabledbool, default nullEnables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes
• descriptionstring, default nullUser-created description for the replication group
• enginestring, default "redis"Name of the cache engine to be used for this cache cluster. Valid values are memcached, redis, or valkey
• engine_versionstring, default nullVersion number of the cache engine to be used. If not set, defaults to the latest version
• final_snapshot_identifierstring, default null(Redis only) Name of your final cluster snapshot. If omitted, no final snapshot will be made
• global_replication_group_idstring, default nullThe ID of the global replication group to which this replication group should belong
• global_replication_group_id_suffixstring, default nullThe ID suffix of the global replication group
• ip_discoverystring, default nullThe IP version to advertise in the discovery protocol. Valid values are ipv4 or ipv6
• log_delivery_configurationany, default {...}(Redis OSS or Valkey) Specifies the destination and format of Redis OSS/Valkey SLOWLOG or Redis OSS/Valkey Engine Log
• maintenance_windowstring, default nullSpecifies the weekly time range for when maintenance on the cache cluster is performed. The format is ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC)
• multi_az_enabledbool, default falseSpecifies whether to enable Multi-AZ Support for the replication group. If true, automatic_failover_enabled must also be enabled. Defaults to false
• network_typestring, default nullThe IP versions for cache cluster connections. Valid values are ipv4, ipv6 or dual_stack
• node_typestring, default nullThe instance class used. For Memcached, changing this value will re-create the resource
• notification_topic_arnstring, default nullARN of an SNS topic to send ElastiCache notifications to
• num_cache_clustersnumber, default nullNumber of cache clusters (primary and replicas) this replication group will have. If Multi-AZ is enabled, the value of this parameter must be at least 2. Updates will occur before other modifications. Conflicts with num_node_groups. Defaults to 1
• num_cache_nodesnumber, default 1The initial number of cache nodes that the cache cluster will have. For Redis, this value must be 1. For Memcached, this value must be between 1 and 40. If this number is reduced on subsequent runs, the highest numbered nodes will be removed
• num_node_groupsnumber, default nullNumber of node groups (shards) for this Redis replication group. Changing this number will trigger a resizing operation before other settings modifications
• outpost_modestring, default nullSpecify the outpost mode that will apply to the cache cluster creation. Valid values are single-outpost and cross-outpost, however AWS currently only supports single-outpost mode
• parameter_group_descriptionstring, default nullThe description of the ElastiCache parameter group. Defaults to Managed by Terraform
• parameter_group_familystring, default ""The family of the ElastiCache parameter group
• parameter_group_namestring, default nullThe name of the parameter group. If create_parameter_group is true, this is the name assigned to the parameter group created. Otherwise, this is the name of an existing parameter group
• parameterslist(map(string)), default []List of ElastiCache parameters to apply
• portnumber, default nullThe port number on which each of the cache nodes will accept connections. For Memcached the default is 11211, and for Redis the default port is 6379
• preferred_availability_zoneslist(string), default []List of the Availability Zones in which cache nodes are created
• preferred_cache_cluster_azslist(string), default []List of EC2 availability zones in which the replication group's cache clusters will be created. The order of the availability zones in the list is considered. The first item in the list will be the primary node. Ignored when updating
• preferred_outpost_arnstring, default null(Required if outpost_mode is specified) The outpost ARN in which the cache cluster will be created
• replicas_per_node_groupnumber, default nullNumber of replica nodes in each node group. Changing this number will trigger a resizing operation before other settings modifications. Valid values are 0 to 5
• replication_group_idstring, default nullReplication group identifier. When create_replication_group is set to true, this is the ID assigned to the replication group created. When create_replication_group is set to false, this is the ID of an externally created replication group
• security_group_descriptionstring, default nullDescription of the security group created
• security_group_idslist(string), default []One or more VPC security groups associated with the cache cluster
• security_group_namestring, default nullName to use on security group created
• security_group_nameslist(string), default []Names of one or more Amazon VPC security groups associated with this replication group
• security_group_rulesany, default {}Security group ingress and egress rules to add to the security group created
• security_group_tagsmap(string), default {}A map of additional tags to add to the security group created
• security_group_use_name_prefixbool, default trueDetermines whether the security group name (security_group_name) is used as a prefix
• snapshot_arnslist(string), default [](Redis only) Single-element string list containing an Amazon Resource Name (ARN) of a Redis RDB snapshot file stored in Amazon S3
• snapshot_namestring, default null(Redis only) Name of a snapshot from which to restore data into the new node group. Changing snapshot_name forces a new resource
• snapshot_windowstring, default null(Redis only) Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00
• subnet_group_descriptionstring, default nullDescription for the Elasticache subnet group
• subnet_idslist(string), default []List of VPC Subnet IDs for the Elasticache subnet group
• tagsmap(string), default {}A map of tags to add to all resources
• timeoutsmap(string), default {}Define maximum timeout for creating, updating, and deleting cluster resource
• transit_encryption_modestring, default nullA setting that enables clients to migrate to in-transit encryption with no downtime. Valid values are preferred and required
• user_group_idslist(string), default nullUser Group ID to associate with the replication group. Only a maximum of one (1) user group ID is valid
• vpc_idstring, default nullIdentifier of the VPC where the security group will be created