ElastiCache

Implementation details for API elasticache

Coverage Overview

ElastiCache is supported by LocalStack only in the pro version.

AvailabilityTesting*
OperationImplementedEditionInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
AddTagsToResource✔️pro✔️✔️
AuthorizeCacheSecurityGroupIngress
BatchApplyUpdateAction
BatchStopUpdateAction
CompleteMigration
CopySnapshot
CreateCacheCluster✔️pro✔️✔️✔️✔️✔️Show Tests
CreateCacheParameterGroup✔️pro✔️✔️✔️Show Tests
CreateCacheSecurityGroup✔️pro✔️Show Tests
CreateCacheSubnetGroup✔️pro✔️✔️✔️✔️✔️Show Tests
CreateGlobalReplicationGroup
CreateReplicationGroup✔️pro✔️✔️✔️✔️✔️Show Tests
CreateSnapshot
CreateUser
CreateUserGroup
DecreaseNodeGroupsInGlobalReplicationGroup
DecreaseReplicaCount
DeleteCacheCluster✔️pro✔️✔️✔️✔️✔️Show Tests
DeleteCacheParameterGroup✔️pro✔️✔️✔️Show Tests
DeleteCacheSecurityGroup✔️pro✔️Show Tests
DeleteCacheSubnetGroup✔️pro✔️✔️✔️✔️✔️Show Tests
DeleteGlobalReplicationGroup
DeleteReplicationGroup✔️pro✔️✔️✔️Show Tests
DeleteSnapshot
DeleteUser
DeleteUserGroup
DescribeCacheClusters✔️pro✔️✔️✔️✔️✔️Show Tests
DescribeCacheEngineVersions
DescribeCacheParameterGroups✔️pro✔️✔️✔️Show Tests
DescribeCacheParameters✔️pro✔️✔️✔️Show Tests
DescribeCacheSecurityGroups✔️pro✔️Show Tests
DescribeCacheSubnetGroups✔️pro✔️✔️✔️✔️✔️Show Tests
DescribeEngineDefaultParameters
DescribeEvents
DescribeGlobalReplicationGroups
DescribeReplicationGroups✔️pro✔️✔️✔️Show Tests
DescribeReservedCacheNodes
DescribeReservedCacheNodesOfferings
DescribeServiceUpdates
DescribeSnapshots
DescribeUpdateActions
DescribeUserGroups
DescribeUsers
DisassociateGlobalReplicationGroup
FailoverGlobalReplicationGroup
IncreaseNodeGroupsInGlobalReplicationGroup
IncreaseReplicaCount
ListAllowedNodeTypeModifications
ListTagsForResource✔️pro✔️✔️
ModifyCacheCluster✔️pro✔️Show Tests
ModifyCacheParameterGroup✔️pro✔️✔️✔️Show Tests
ModifyCacheSubnetGroup✔️pro✔️Show Tests
ModifyGlobalReplicationGroup
ModifyReplicationGroup✔️pro✔️Show Tests
ModifyReplicationGroupShardConfiguration
ModifyUser
ModifyUserGroup
PurchaseReservedCacheNodesOffering
RebalanceSlotsInGlobalReplicationGroup
RebootCacheCluster
RemoveTagsFromResource✔️pro✔️✔️
ResetCacheParameterGroup
RevokeCacheSecurityGroupIngress
StartMigration
TestFailover

Terminology

  • Internal Test Suite: tested by LocalStack's internal integration test suite
  • External Test Suite: covered by an external integration test suite, that runs against LocalStack
  • Terraform Validated: operation tested with Terraform
  • AWS Validated: the integration test that includes this operation call was validated against AWS
  • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

Testing Details

This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

How to read the test details?

For each operation we put up a list of the related integration test cases.
Those operation calls have been recorded during the exeuction of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

  • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
  • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
    • test name
    • status code returned (which is the expected one for the test case)
    • information about validation:
      • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
      • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


CreateCacheCluster

Parameters: AutoMinorVersionUpgrade, CacheClusterId, CacheNodeType, Engine, NumCacheNodes, SecurityGroupIds
  • LocalStack Pro
    • test_create_via_cloudformation LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_via_cloudformation HTTP Status Code: 200
Parameters: CacheClusterId
  • LocalStack Pro
    • test_cluster_no_engine LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_cluster_no_engine HTTP Status Code: 400 (InvalidParameterValueException) AWS validated Snapshot Tested
Parameters: CacheClusterId, CacheNodeType, CacheSubnetGroupName, Engine, NumCacheNodes, SecurityGroupIds
  • LocalStack Pro
    • test_cache_cluster[redis] LocalStack Pro: tests/integration/cloudformation/resources/test_elasticache.py::test_cache_cluster[redis] HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: CacheClusterId, CacheNodeType, Engine
  • LocalStack Pro
    • test_create_delete_multiple_clusters LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_delete_multiple_clusters HTTP Status Code: 200
    • test_redis_standalone LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_standalone HTTP Status Code: 200
Parameters: CacheClusterId, CacheNodeType, Engine, NumCacheNodes
  • LocalStack Pro
    • test_cluster_redis_num_nodes_greater_than_one LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_cluster_redis_num_nodes_greater_than_one HTTP Status Code: 400 (InvalidParameterValueException) AWS validated Snapshot Tested
Parameters: CacheClusterId, CacheNodeType, Engine, Port
  • LocalStack Pro
    • test_cache_cluster_custom_port LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_cache_cluster_custom_port HTTP Status Code: 200
Parameters: CacheClusterId, CacheNodeType, Engine, ReplicationGroupId
  • LocalStack Pro
    • test_replication_group LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_replication_group HTTP Status Code: 404 (ReplicationGroupNotFoundFault)
Parameters: CacheClusterId, Engine
  • LocalStack Pro
    • test_cluster_no_cache_type LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_cluster_no_cache_type HTTP Status Code: 400 (InvalidParameterValueException) AWS validated Snapshot Tested

CreateCacheParameterGroup

Parameters: CacheParameterGroupFamily, CacheParameterGroupName, Description
  • LocalStack Pro
    • test_cache_parameter_groups LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_cache_parameter_groups HTTP Status Code: 200
Parameters: CacheParameterGroupFamily, CacheParameterGroupName, Description, Tags
  • LocalStack Pro
    • test_create_via_cloudformation LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_via_cloudformation HTTP Status Code: 200

CreateCacheSecurityGroup

Parameters: CacheSecurityGroupName, Description, Tags
  • LocalStack Pro
    • test_create_via_cloudformation LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_via_cloudformation HTTP Status Code: 200

CreateCacheSubnetGroup

Parameters: CacheSubnetGroupDescription, CacheSubnetGroupName, SubnetIds
  • LocalStack Pro
    • test_cache_cluster[redis] LocalStack Pro: tests/integration/cloudformation/resources/test_elasticache.py::test_cache_cluster[redis] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_cache_subnet_groups LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_cache_subnet_groups HTTP Status Code: 200
Parameters: CacheSubnetGroupDescription, CacheSubnetGroupName, SubnetIds, Tags
  • LocalStack Pro
    • test_create_via_cloudformation LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_via_cloudformation HTTP Status Code: 200

CreateReplicationGroup

Parameters: CacheNodeType, Engine, GlobalReplicationGroupId, ReplicationGroupDescription, ReplicationGroupId
  • LocalStack Pro
    • test_replication_group LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_replication_group HTTP Status Code: 200
Parameters: CacheNodeType, Engine, NumCacheClusters, NumNodeGroups, ReplicationGroupDescription, ReplicationGroupId
  • LocalStack Pro
    • test_redis_cluster_mode[0-1] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[0-1] HTTP Status Code: 200
    • test_redis_cluster_mode[1-1] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[1-1] HTTP Status Code: 200
Parameters: CacheNodeType, Engine, NumNodeGroups, ReplicasPerNodeGroup, ReplicationGroupDescription, ReplicationGroupId
  • LocalStack Pro
    • test_redis_cluster_mode[0-2] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[0-2] HTTP Status Code: 200
    • test_redis_cluster_mode[0-4] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[0-4] HTTP Status Code: 200
    • test_redis_cluster_mode[1-2] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[1-2] HTTP Status Code: 200
    • test_redis_cluster_mode[1-4] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[1-4] HTTP Status Code: 200
Parameters: CacheNodeType, Engine, ReplicationGroupDescription, ReplicationGroupId, Tags
  • LocalStack Pro
    • test_create_via_cloudformation LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_via_cloudformation HTTP Status Code: 200
Parameters: Engine, ReplicationGroupDescription, ReplicationGroupId
  • LocalStack Pro
    • test_replication_group_no_cache_type LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_replication_group_no_cache_type HTTP Status Code: 400 (InvalidParameterValueException) AWS validated Snapshot Tested
Parameters: ReplicationGroupDescription, ReplicationGroupId
  • LocalStack Pro
    • test_replication_group_no_engine LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_replication_group_no_engine HTTP Status Code: 400 (InvalidParameterValueException) AWS validated Snapshot Tested

DeleteCacheCluster

Parameters: CacheClusterId
  • LocalStack Pro
    • test_cache_cluster[redis] LocalStack Pro: tests/integration/cloudformation/resources/test_elasticache.py::test_cache_cluster[redis] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_cache_cluster_custom_port LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_cache_cluster_custom_port HTTP Status Code: 200
    • test_create_delete_multiple_clusters LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_delete_multiple_clusters HTTP Status Code: 200
    • test_create_via_cloudformation LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_via_cloudformation HTTP Status Code: 200
    • test_redis_standalone LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_standalone HTTP Status Code: 200
    • test_create_delete_multiple_clusters LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_delete_multiple_clusters HTTP Status Code: 404 (CacheClusterNotFoundFault)
    • test_create_delete_multiple_clusters LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_delete_multiple_clusters HTTP Status Code: 404 (CacheClusterNotFoundFault)
    • test_create_delete_multiple_clusters LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_delete_multiple_clusters HTTP Status Code: 404 (CacheClusterNotFoundFault)
    • test_create_delete_multiple_clusters LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_delete_multiple_clusters HTTP Status Code: 404 (CacheClusterNotFoundFault)
    • test_redis_cluster_mode[0-1] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[0-1] HTTP Status Code: 404 (CacheClusterNotFoundFault)
    • test_redis_cluster_mode[0-2] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[0-2] HTTP Status Code: 404 (CacheClusterNotFoundFault)
    • test_redis_cluster_mode[0-4] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[0-4] HTTP Status Code: 404 (CacheClusterNotFoundFault)
    • test_redis_cluster_mode[1-1] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[1-1] HTTP Status Code: 404 (CacheClusterNotFoundFault)
    • test_redis_cluster_mode[1-2] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[1-2] HTTP Status Code: 404 (CacheClusterNotFoundFault)
    • test_redis_cluster_mode[1-4] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[1-4] HTTP Status Code: 404 (CacheClusterNotFoundFault)
    • test_redis_standalone LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_standalone HTTP Status Code: 404 (CacheClusterNotFoundFault)

DeleteCacheParameterGroup

Parameters: CacheParameterGroupName
  • LocalStack Pro
    • test_cache_parameter_groups LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_cache_parameter_groups HTTP Status Code: 200
    • test_create_via_cloudformation LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_via_cloudformation HTTP Status Code: 200

DeleteCacheSecurityGroup

Parameters: CacheSecurityGroupName
  • LocalStack Pro
    • test_create_via_cloudformation LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_via_cloudformation HTTP Status Code: 200

DeleteCacheSubnetGroup

Parameters: CacheSubnetGroupName
  • LocalStack Pro
    • test_cache_cluster[redis] LocalStack Pro: tests/integration/cloudformation/resources/test_elasticache.py::test_cache_cluster[redis] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_cache_subnet_groups LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_cache_subnet_groups HTTP Status Code: 200
    • test_create_via_cloudformation LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_via_cloudformation HTTP Status Code: 200

DeleteReplicationGroup

Parameters: ReplicationGroupId
  • LocalStack Pro
    • test_create_via_cloudformation LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_via_cloudformation HTTP Status Code: 200
    • test_redis_cluster_mode[0-1] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[0-1] HTTP Status Code: 200
    • test_redis_cluster_mode[0-2] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[0-2] HTTP Status Code: 200
    • test_redis_cluster_mode[0-4] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[0-4] HTTP Status Code: 200
    • test_redis_cluster_mode[1-1] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[1-1] HTTP Status Code: 200
    • test_redis_cluster_mode[1-2] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[1-2] HTTP Status Code: 200
    • test_redis_cluster_mode[1-4] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[1-4] HTTP Status Code: 200
    • test_replication_group LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_replication_group HTTP Status Code: 200

DescribeCacheClusters

Parameters: - (without any parameters)
  • LocalStack Pro
    • test_create_via_cloudformation LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_via_cloudformation HTTP Status Code: 200
Parameters: CacheClusterId
  • LocalStack Pro
    • test_cache_cluster[redis] LocalStack Pro: tests/integration/cloudformation/resources/test_elasticache.py::test_cache_cluster[redis] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_redis_standalone LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_standalone HTTP Status Code: 200
Parameters: MaxRecords
  • LocalStack Pro
    • test_cache_cluster[redis] LocalStack Pro: tests/integration/cloudformation/resources/test_elasticache.py::test_cache_cluster[redis] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_create_via_cloudformation LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_via_cloudformation HTTP Status Code: 200

DescribeCacheParameterGroups

Parameters: - (without any parameters)
  • LocalStack Pro
    • test_create_via_cloudformation LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_via_cloudformation HTTP Status Code: 200
    • test_create_via_cloudformation LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_via_cloudformation HTTP Status Code: 200
Parameters: CacheParameterGroupName
  • LocalStack Pro
    • test_cache_parameter_groups LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_cache_parameter_groups HTTP Status Code: 200

DescribeCacheParameters

Parameters: CacheParameterGroupName
  • LocalStack Pro
    • test_cache_parameter_groups LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_cache_parameter_groups HTTP Status Code: 200

DescribeCacheSecurityGroups

Parameters: - (without any parameters)
  • LocalStack Pro
    • test_create_via_cloudformation LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_via_cloudformation HTTP Status Code: 200

DescribeCacheSubnetGroups

Parameters: - (without any parameters)
  • LocalStack Pro
    • test_cache_cluster[redis] LocalStack Pro: tests/integration/cloudformation/resources/test_elasticache.py::test_cache_cluster[redis] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_create_via_cloudformation LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_via_cloudformation HTTP Status Code: 200
Parameters: CacheSubnetGroupName
  • LocalStack Pro
    • test_cache_subnet_groups LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_cache_subnet_groups HTTP Status Code: 200

DescribeReplicationGroups

Parameters: - (without any parameters)
  • LocalStack Pro
    • test_create_via_cloudformation LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_via_cloudformation HTTP Status Code: 200
Parameters: ReplicationGroupId
  • LocalStack Pro
    • test_redis_cluster_mode[0-1] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[0-1] HTTP Status Code: 200
    • test_redis_cluster_mode[0-2] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[0-2] HTTP Status Code: 200
    • test_redis_cluster_mode[0-4] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[0-4] HTTP Status Code: 200
    • test_redis_cluster_mode[1-1] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[1-1] HTTP Status Code: 200
    • test_redis_cluster_mode[1-2] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[1-2] HTTP Status Code: 200
    • test_redis_cluster_mode[1-4] LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_cluster_mode[1-4] HTTP Status Code: 200
    • test_replication_group LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_replication_group HTTP Status Code: 200

ModifyCacheCluster

Parameters: CacheClusterId, NumCacheNodes
  • LocalStack Pro
    • test_redis_standalone LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_redis_standalone HTTP Status Code: 200

ModifyCacheParameterGroup

Parameters: CacheParameterGroupName, ParameterNameValues
  • LocalStack Pro
    • test_cache_parameter_groups LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_cache_parameter_groups HTTP Status Code: 200
    • test_create_via_cloudformation LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_create_via_cloudformation HTTP Status Code: 200

ModifyCacheSubnetGroup

Parameters: CacheSubnetGroupDescription, CacheSubnetGroupName
  • LocalStack Pro
    • test_cache_subnet_groups LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_cache_subnet_groups HTTP Status Code: 200

ModifyReplicationGroup

Parameters: ReplicationGroupDescription, ReplicationGroupId
  • LocalStack Pro
    • test_replication_group LocalStack Pro: tests/integration/test_elasticache.py::TestElastiCache::test_replication_group HTTP Status Code: 200


Last modified March 20, 2023: improve Coverage Docs (#505) (46f2fb0c0)