1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192
|
import copy
import random
import string
from re import compile as re_compile
from typing import Any, Optional, Union
from moto.core.base_backend import BackendDict, BaseBackend
from moto.core.common_models import BaseModel
from moto.core.utils import utcnow
from moto.utilities.paginator import paginate
from moto.utilities.tagging_service import TaggingService
from moto.utilities.utils import get_partition
from ..moto_api._internal import mock_random
from .exceptions import (
CacheClusterAlreadyExists,
CacheClusterNotFound,
CacheSubnetGroupAlreadyExists,
CacheSubnetGroupNotFound,
InvalidARNFault,
InvalidParameterCombinationException,
InvalidParameterValueException,
InvalidSubnet,
ReplicationGroupAlreadyExists,
ReplicationGroupNotFound,
SnapshotAlreadyExists,
SnapshotNotFound,
UserAlreadyExists,
UserNotFound,
)
from .utils import PAGINATION_MODEL, AuthenticationTypes
class User(BaseModel):
def __init__(
self,
account_id: str,
region: str,
user_id: str,
user_name: str,
access_string: str,
engine: str,
no_password_required: bool,
passwords: Optional[list[str]] = None,
authentication_type: Optional[str] = None,
tags: Optional[list[dict[str, str]]] = None,
):
self.id = user_id
self.name = user_name
self.engine = engine
self.passwords = passwords or []
self.access_string = access_string
self.no_password_required = no_password_required
self.status = "active"
self.minimum_engine_version = "6.0"
self.user_group_ids: list[str] = []
self.region = region
self.arn = f"arn:{get_partition(self.region)}:elasticache:{self.region}:{account_id}:user:{self.id}"
self.authentication_type = authentication_type
self.tags = tags or []
@property
def authentication(self) -> dict[str, Union[str, int, None]]:
return {
"Type": "no-password"
if self.no_password_required
else self.authentication_type,
"PasswordCount": len(self.passwords) if self.passwords else None,
}
class CacheCluster(BaseModel):
def __init__(
self,
account_id: str,
region_name: str,
cache_cluster_id: str,
cache_node_type: str,
replication_group_id: Optional[str],
az_mode: Optional[str],
preferred_availability_zone: Optional[str],
num_cache_nodes: Optional[int],
engine: Optional[str],
engine_version: Optional[str],
cache_parameter_group_name: Optional[str],
cache_subnet_group_name: Optional[str],
transit_encryption_enabled: Optional[bool],
network_type: Optional[str],
ip_discovery: Optional[str],
snapshot_name: Optional[str],
preferred_maintenance_window: Optional[str],
port: Optional[int],
notification_topic_arn: Optional[str],
auto_minor_version_upgrade: Optional[bool],
snapshot_retention_limit: Optional[int],
snapshot_window: Optional[str],
auth_token: Optional[str],
outpost_mode: Optional[str],
preferred_outpost_arn: Optional[str],
preferred_availability_zones: Optional[list[str]],
cache_security_group_names: Optional[list[str]],
security_group_ids: Optional[list[str]],
tags: Optional[list[dict[str, str]]],
snapshot_arns: Optional[list[str]],
preferred_outpost_arns: Optional[list[str]],
log_delivery_configurations: list[dict[str, Any]],
cache_node_ids_to_remove: Optional[list[str]],
cache_node_ids_to_reboot: Optional[list[str]],
):
self.cache_cluster_id = cache_cluster_id
self.az_mode = az_mode
self.preferred_availability_zone = preferred_availability_zone
self.preferred_availability_zones = preferred_availability_zones or []
self.engine = engine or "redis"
self.engine_version = engine_version
if engine == "redis":
self.num_cache_nodes = 1
self.replication_group_id = replication_group_id
self.snapshot_arns = snapshot_arns or []
self.snapshot_name = snapshot_name
self.snapshot_window = snapshot_window
if engine == "memcached":
if num_cache_nodes is None:
self.num_cache_nodes = 1
elif 1 <= num_cache_nodes <= 40:
self.num_cache_nodes = num_cache_nodes
self.cache_node_type = cache_node_type
self.cache_parameter_group_name = cache_parameter_group_name
self.cache_subnet_group_name = cache_subnet_group_name
self.cache_security_group_names = cache_security_group_names or []
self.security_group_ids = security_group_ids or []
self.tags = tags or []
self.preferred_maintenance_window = preferred_maintenance_window
self.port = port or 6379
self.notification_topic_arn = notification_topic_arn
self.auto_minor_version_upgrade = auto_minor_version_upgrade
self.snapshot_retention_limit = snapshot_retention_limit or 0
self.auth_token = auth_token
self.auth_token_enabled = bool(auth_token)
self.outpost_mode = outpost_mode
self.preferred_outpost_arn = preferred_outpost_arn
self.preferred_outpost_arns = preferred_outpost_arns or []
self.log_delivery_configurations = log_delivery_configurations or []
self.transit_encryption_enabled = transit_encryption_enabled
self.network_type = network_type
self.ip_discovery = ip_discovery
self.cache_node_ids_to_remove = cache_node_ids_to_remove
self.cache_node_ids_to_reboot = cache_node_ids_to_reboot
self.cache_cluster_create_time = utcnow()
self.auth_token_last_modified_date = utcnow()
self.cache_cluster_status = "available"
self.arn = f"arn:{get_partition(region_name)}:elasticache:{region_name}:{account_id}:cluster:{cache_cluster_id}"
self.cache_node_id = str(mock_random.uuid4())
self.status = "available"
class CacheSubnetGroup(BaseModel):
def __init__(
self,
account_id: str,
region_name: str,
cache_subnet_group_name: str,
cache_subnet_group_description: str,
subnet_ids: list[str],
tags: Optional[list[dict[str, str]]],
):
self.cache_subnet_group_name = cache_subnet_group_name
self.cache_subnet_group_description = cache_subnet_group_description
self.subnet_ids = subnet_ids
self.tags = tags or []
# Only import ec2_backends if necessary
from moto.ec2.models import ec2_backends
ec2_backend = ec2_backends[account_id][region_name]
self.supported_network_types = []
self.subnets = []
vpc_exists = False
try:
# Get VPC details from provided subnet IDs
subnets = ec2_backend.describe_subnets(subnet_ids=subnet_ids)
vpc_exists = True
except Exception as e:
# Should raise InvalidSubnet if subnet_ids are invalid
if "InvalidSubnet" in str(e):
for subnet_id in subnet_ids:
subnet_response: dict[str, Any] = {}
subnet_response["subnet_identifier"] = subnet_id
subnet_response["Subnet_availability_zone"] = {"Name": "us-east-1a"}
subnet_response["supported_network_types"] = ["ipv4"]
self.subnets.append(subnet_response)
vpcs = ["vpc-0123456789abcdef0"]
self.supported_network_types = ["ipv4"]
if vpc_exists:
vpcs = []
for subnet in subnets:
subnet_response = {}
vpcs.append(subnet.vpc_id)
subnet_response["subnet_identifier"] = subnet.id
subnet_response["subnet_availability_zone"] = subnet.availability_zone
subnet_response["supported_network_types"] = []
if subnet.vpc_id != vpcs[0]:
raise InvalidSubnet(subnet_id=subnet.id)
# ipv6 native subnets only appends ipv6
# You can't mix ipv6 native subnets with other types of subnets
if subnet.ipv6_native:
self.supported_network_types.append("ipv6")
subnet_response["supported_network_types"].append("ipv6")
# ipv4 only and dual_stack subnets both append ipv4
elif subnet.cidr_block:
self.supported_network_types.append("ipv4")
subnet_response["supported_network_types"].append("ipv4")
if subnet.ipv6_cidr_block_associations and subnet.cidr_block:
self.supported_network_types.append("dual_stack")
subnet_response["supported_network_types"].append("dual_stack")
self.subnets.append(subnet_response)
if self.supported_network_types:
self.supported_network_types = list(set(self.supported_network_types))
self.arn = f"arn:aws:elasticache:{region_name}:{account_id}:subnetgroup:{cache_subnet_group_name}"
self.vpc_id = vpcs[0] if vpcs else None
class ReplicationGroup(BaseModel):
def __init__(
self,
account_id: str,
region_name: str,
replication_group_id: str,
preferred_cache_cluster_azs: Optional[list[str]],
num_cache_clusters: Optional[int],
num_node_groups: Optional[int],
replicas_per_node_group: Optional[int],
node_group_configuration: list[dict[str, Any]],
preferred_maintenance_window: Optional[str],
replication_group_description: str,
primary_cluster_id: Optional[str],
automatic_failover_enabled: bool,
global_replication_group_id: Optional[str],
multi_az_enabled: Optional[bool],
port: Optional[int],
snapshot_retention_limit: int,
snapshot_window: Optional[str],
cluster_mode: Optional[str],
cache_node_type: Optional[str],
auth_token: Optional[str],
transit_encryption_enabled: Optional[bool],
at_rest_encryption_enabled: Optional[bool],
kms_key_id: Optional[str],
user_group_ids: list[str],
log_delivery_configurations: list[dict[str, Any]],
data_tiering_enabled: Optional[bool],
auto_minor_version_upgrade: Optional[bool],
engine: Optional[str],
network_type: Optional[str],
ip_discovery: Optional[str],
transit_encryption_mode: Optional[str],
cache_security_group_names: Optional[list[str]],
cache_subnet_group_name: Optional[str],
security_group_ids: Optional[list[str]],
tags: Optional[list[dict[str, str]]],
notification_topic_arn: Optional[str],
serverless_cache_snapshot_name: Optional[str],
cache_parameter_group_name: Optional[str],
engine_version: Optional[str],
snapshot_arns: Optional[list[str]],
snapshot_name: Optional[str],
):
tags = tags or []
self.cluster_mode = cluster_mode or "disabled"
self.replication_group_id = replication_group_id
self.description = replication_group_description
self.port = port or 6379
self.status = "available"
preferred_cache_cluster_azs = preferred_cache_cluster_azs or []
replicas_per_node_group = replicas_per_node_group or 0
# This field is only present if we are creating a
# secondary replication group and associating it with an existing
# global replication group and primary cluster.
if global_replication_group_id:
self.global_replication_group_id = global_replication_group_id
self.global_replication_group_member_role = "SECONDARY"
else:
self.global_replication_group_id = ""
# Leaving off PendingModifiedValues for now
# until global_replication_group is implemented.
self.primary_cluster_id = primary_cluster_id
self.node_groups = []
random_str = "".join(
random.choices(string.ascii_lowercase + string.digits, k=6)
)
region_short = "use1"
replication_group_domain = (
f"{replication_group_id}.{random_str}.{region_short}.cache.amazonaws.com"
)
self.member_clusters: list[str] = []
self.member_clusters_outpost_arns: list[str] = []
if not num_node_groups:
num_node_groups = 1
for i in range(num_node_groups):
node_group: dict[str, Any] = {}
node_group["node_group_id"] = f"{i + 1:0>4}"
node_group["status"] = "available"
node_group["node_group_members"] = []
if self.cluster_mode == "enabled":
if i == 0:
node_group["slots"] = "0-5461"
else:
# slots cannot overlap among node groups
node_group["slots"] = (
f"{(5460 * (i)) + (i + 1)}-{(5460 * (i + 1)) + (i + 1)}"
)
replicas_per_node_group = replicas_per_node_group or 0
self._set_node_members_clusters_enabled(
member_clusters=self.member_clusters,
replication_group_id=replication_group_id,
replicas_per_node_group=replicas_per_node_group,
node_group_configuration=node_group_configuration,
node_group=node_group,
member_clusters_outpost_arns=self.member_clusters_outpost_arns,
)
self.configuration_endpoint: dict[str, Any] = {}
self.configuration_endpoint["address"] = (
f"clustercfg.{replication_group_domain}"
)
self.configuration_endpoint["port"] = self.port
# self.cluster_mode is disabled or not set
else:
node_group["primary_endpoint_address"] = (
f"master.{replication_group_domain}"
)
node_group["reader_endpoint_address"] = (
f"replica.{replication_group_domain}"
)
node_group["port"] = self.port
node_group["primary_endpoint"] = {
"address": node_group["primary_endpoint_address"],
"port": self.port,
}
num_cache_clusters = num_cache_clusters or 1
self._set_node_members_clusters_disabled(
member_clusters=self.member_clusters,
replication_group_id=replication_group_id,
replication_group_domain=replication_group_domain,
node_group=node_group,
preferred_cache_cluster_azs=preferred_cache_cluster_azs,
num_cache_clusters=num_cache_clusters,
replicas_per_node_group=replicas_per_node_group,
)
self.node_groups.append(node_group)
self.automatic_failover = (
"enabled" if automatic_failover_enabled else "disabled"
)
self.multi_az = "enabled" if multi_az_enabled else "disabled"
self.snapshot_retention_limit = snapshot_retention_limit or 0
self.snapshot_window = snapshot_window or "05:00-6:00"
self.snapshotting_cluster_id = None
if self.snapshot_retention_limit > 0:
if len(self.member_clusters) > 1:
self.snapshotting_cluster_id = self.member_clusters[1]
else:
self.snapshotting_cluster_id = self.member_clusters[0]
self.cluster_enabled = True if self.cluster_mode == "enabled" else False
self.cache_node_type = cache_node_type or "cache.t4g.micro"
self.auth_token_enabled = bool(auth_token)
self.auth_token_last_modified_date = (
utcnow() if self.auth_token_enabled else None
)
self.transit_encryption_enabled = transit_encryption_enabled or False
self.at_rest_encryption_enabled = at_rest_encryption_enabled or False
self.kms_key_id = kms_key_id
self.arn = f"arn:aws:elasticache:{region_name}:{account_id}:replicationgroup:{replication_group_id}"
self.user_group_ids = user_group_ids or []
self.log_delivery_configurations = self._get_log_delivery_configurations(
log_delivery_configurations
)
self.replication_group_create_time = utcnow()
self.data_tiering = "enabled" if data_tiering_enabled else "disabled"
self.auto_minor_version_upgrade = auto_minor_version_upgrade
self.network_type = network_type or "ipv4"
self.ip_discovery = ip_discovery or "ipv4"
self.transit_encryption_mode = transit_encryption_mode
self.engine = engine or "redis"
# Parameters not returned by create or describe replication group
self.cache_security_group_names = cache_security_group_names
self.cache_subnet_group_name = cache_subnet_group_name
self.security_group_ids = security_group_ids
self.tags = tags
self.preferred_maintenance_window = preferred_maintenance_window
self.notification_topic_arn = notification_topic_arn
self.serverless_cache_snapshot_name = serverless_cache_snapshot_name
self.cache_parameter_group_name = cache_parameter_group_name
self.engine_version = engine_version
self.snapshot_arns = snapshot_arns
self.snapshot_name = snapshot_name
@property
def global_replication_group_info(self) -> dict[str, str]:
return {
"GlobalReplicationGroupId": self.global_replication_group_id,
"GlobalReplicationGroupMemberRole": self.global_replication_group_member_role,
}
def _get_log_delivery_configurations(
self, log_delivery_configurations: list[dict[str, Any]]
) -> list[dict[str, Any]]:
log_delivery_configurations_resp = []
if log_delivery_configurations:
for log_delivery_configuration in log_delivery_configurations:
log_config_resp = copy.copy(log_delivery_configuration)
log_config_resp["status"] = "active"
log_config_resp["message"] = "Log delivery configuration is active."
log_delivery_configurations_resp.append(log_config_resp)
return log_delivery_configurations_resp
# This method will set populate the node_group with node_group_members
# and member_clusters with the cache_cluster_ids of the primary and replicas.
def _set_node_members_clusters_enabled(
self,
member_clusters: list[str],
replication_group_id: str,
replicas_per_node_group: int,
node_group_configuration: list[dict[str, Any]],
node_group: dict[str, Any],
member_clusters_outpost_arns: list[str],
) -> None:
replica_count = replicas_per_node_group
primary_node = {}
primary_node["cache_cluster_id"] = (
f"{replication_group_id}-{node_group['node_group_id']}-001"
)
primary_node["cache_node_id"] = node_group["node_group_id"]
# Set the PreferredAvailabilityZone,
# default to us-east-1a for moto only
primary_node["preferred_availability_zone"] = "us-east-1a"
# With node_group_configurations
node_config = {}
if node_group_configuration:
for config in node_group_configuration:
if node_group["node_group_id"] == config.get("NodeGroupId"):
node_config = config
# overwrite slots if part of node config
if config.get("Slots"):
node_group["slots"] = config.get("Slots")
replica_count_val = config.get("ReplicaCount")
if replica_count_val is not None:
replica_count = int(replica_count_val)
else:
replica_count = replicas_per_node_group
primary_node["preferred_availability_zone"] = config.get(
"PrimaryAvailabilityZone", "us-east-1a"
)
primary_outpost_arn = config.get("PrimaryOutpostArn", "")
if primary_outpost_arn:
primary_node["preferred_outpost_arn"] = primary_outpost_arn
member_clusters_outpost_arns.append(primary_outpost_arn)
node_group["node_group_members"].append(primary_node)
member_clusters.append(primary_node["cache_cluster_id"])
# Loop through the number of replicas per node group
for r in range(1, replica_count + 1):
replica_node = {}
# r + 1 because primary is 001
replica_node["cache_cluster_id"] = (
f"{replication_group_id}-{node_group['node_group_id']}-{r + 1:0>3}"
)
replica_node["cache_node_id"] = node_group["node_group_id"]
# Set the ReplicaAvailabiilityZone,
# default to us-east-1b for moto only
replica_node["preferred_availability_zone"] = "us-east-1b"
if node_config:
replica_az = node_config.get("ReplicaAvailabilityZones")
if replica_az:
if len(replica_az) >= r:
replica_node["preferred_availability_zone"] = replica_az[r - 1]
elif len(replica_az) >= 1:
replica_node["preferred_availability_zone"] = replica_az[0]
replica_outpost_arns = node_config.get("ReplicaOutpostArns", [])
if replica_outpost_arns:
if len(replica_outpost_arns) >= r:
replica_node["preferred_outpost_arn"] = replica_outpost_arns[
r - 1
]
elif len(replica_outpost_arns) >= 1:
replica_node["preferred_outpost_arn"] = replica_outpost_arns[0]
member_clusters_outpost_arns.append(
replica_node["preferred_outpost_arn"]
)
node_group["node_group_members"].append(replica_node)
member_clusters.append(replica_node["cache_cluster_id"])
def _set_node_members_clusters_disabled(
self,
member_clusters: list[str],
replication_group_id: str,
replication_group_domain: str,
node_group: dict[str, Any],
preferred_cache_cluster_azs: list[str],
num_cache_clusters: int,
replicas_per_node_group: int,
) -> None:
primary_node: dict[str, Any] = {}
primary_node["cache_cluster_id"] = f"{replication_group_id}-001"
primary_node["cache_node_id"] = node_group["node_group_id"]
primary_node["read_endpoint"] = {}
primary_node["read_endpoint"]["address"] = (
f"{primary_node['cache_cluster_id']}.{replication_group_domain}"
)
primary_node["read_endpoint"]["port"] = self.port
if preferred_cache_cluster_azs:
primary_node["preferred_availability_zone"] = preferred_cache_cluster_azs[0]
else:
primary_node["preferred_availability_zone"] = "us-east-1a"
primary_node["current_role"] = "primary"
node_group["node_group_members"].append(primary_node)
member_clusters.append(primary_node["cache_cluster_id"])
if replicas_per_node_group:
num_cache_clusters = replicas_per_node_group + 1
else:
num_cache_clusters = 1
# Use num_cache_clusters when cluster_mode is disabled
for r in range(1, num_cache_clusters):
replica_node: dict[str, Any] = {}
# r + 1 because primary is 001
replica_node["cache_cluster_id"] = f"{replication_group_id}-{r + 1:0>3}"
replica_node["cache_node_id"] = node_group["node_group_id"]
replica_node["read_endpoint"] = {}
replica_node["read_endpoint"]["address"] = (
f"{replica_node['cache_cluster_id']}.{replication_group_domain}"
)
replica_node["read_endpoint"]["port"] = self.port
if preferred_cache_cluster_azs:
if len(preferred_cache_cluster_azs) > r:
replica_az = preferred_cache_cluster_azs[r]
elif len(preferred_cache_cluster_azs) >= 2:
replica_az = preferred_cache_cluster_azs[1]
else:
replica_az = preferred_cache_cluster_azs[0]
else:
replica_az = "us-east-1b"
replica_node["preferred_availability_zone"] = replica_az
replica_node["current_role"] = "replica"
node_group["node_group_members"].append(replica_node)
member_clusters.append(replica_node["cache_cluster_id"])
class Snapshot(BaseModel):
def __init__(
self,
account_id: str,
region_name: str,
automatic_failover: Optional[bool],
auto_minor_version_upgrade: Optional[bool],
cache_cluster_create_time: Optional[str],
cache_cluster_id: Optional[str],
cache_node_type: Optional[str],
cache_parameter_group_name: Optional[str],
cache_subnet_group_name: Optional[str],
engine: Optional[str],
engine_version: Optional[str],
kms_key_id: Optional[str],
num_cache_nodes: Optional[int],
num_node_groups: Optional[int],
port: Optional[int],
preferred_availability_zone: Optional[str],
preferred_maintenance_window: Optional[str],
preferred_outpost_arn: Optional[str],
replication_group_description: Optional[str],
replication_group_id: Optional[str],
snapshot_name: Optional[str],
snapshot_retention_limit: Optional[int],
snapshot_source: Optional[str],
snapshot_status: Optional[str],
snapshot_window: Optional[str],
topic_arn: Optional[str],
tags: Optional[list[dict[str, str]]],
vpc_id: Optional[str] = None,
):
self.arn = f"arn:{get_partition(region_name)}:elasticache:{region_name}:{account_id}:snapshot:{snapshot_name}"
self.automatic_failover = automatic_failover
self.auto_minor_version_upgrade = auto_minor_version_upgrade
self.cache_cluster_create_time = cache_cluster_create_time
self.cache_cluster_id = cache_cluster_id
self.cache_node_type = cache_node_type
self.cache_parameter_group_name = cache_parameter_group_name
self.cache_subnet_group_name = cache_subnet_group_name
self.engine = engine
self.engine_version = engine_version
self.kms_key_id = kms_key_id
self.num_cache_nodes = num_cache_nodes
self.num_node_groups = num_node_groups
self.port = port
self.preferred_availability_zone = preferred_availability_zone
self.preferred_maintenance_window = preferred_maintenance_window
self.preferred_outpost_arn = preferred_outpost_arn
self.replication_group_description = replication_group_description
self.replication_group_id = replication_group_id
self.snapshot_name = snapshot_name
self.snapshot_retention_limit = snapshot_retention_limit
self.snapshot_source = snapshot_source or "manual"
self.snapshot_status = snapshot_status
self.snapshot_window = snapshot_window
self.topic_arn = topic_arn
self.tags = tags or []
self.vpc_id = vpc_id
class ElastiCacheBackend(BaseBackend):
"""Implementation of ElastiCache APIs."""
def __init__(self, region_name: str, account_id: str):
super().__init__(region_name, account_id)
self.arn_regex = re_compile(
r"^arn:aws:elasticache:.*:[0-9]*:(cluster|snapshot|subnetgroup|replicationgroup|user):.*$"
)
self.users = {}
self.users["default"] = User(
account_id=self.account_id,
region=self.region_name,
user_id="default",
user_name="default",
engine="redis",
access_string="on ~* +@all",
no_password_required=True,
)
self.cache_clusters: dict[str, Any] = {}
self.cache_subnet_groups: dict[str, CacheSubnetGroup] = {}
self.replication_groups: dict[str, ReplicationGroup] = {}
self.snapshots: dict[str, Snapshot] = {}
self.tagging_service = TaggingService()
def _get_snapshots_by_param(
self,
ref_id: Optional[str] = None,
source: Optional[str] = None,
) -> list[Snapshot]:
source_map = {
"system": "automated",
"user": "manual",
}
snapshots = list(self.snapshots.values())
if ref_id:
snapshots = [
s
for s in snapshots
if s.cache_cluster_id == ref_id or s.replication_group_id == ref_id
]
if source:
actual_source = source_map.get(source.lower(), source.lower())
snapshots = [s for s in snapshots if s.snapshot_source == actual_source]
return snapshots
def _get_vpc_id_from_cluster(self, cache_cluster_id: str) -> Optional[str]:
if cache_cluster_id and cache_cluster_id in self.cache_clusters:
cache_cluster = self.cache_clusters[cache_cluster_id]
subnet_group_name = cache_cluster.cache_subnet_group_name
if subnet_group_name and subnet_group_name in self.cache_subnet_groups:
return self.cache_subnet_groups[subnet_group_name].vpc_id
return None
def create_user(
self,
user_id: str,
user_name: str,
engine: str,
passwords: list[str],
access_string: str,
no_password_required: bool,
authentication_type: str, # contain it to the str in the enums TODO
tags: Optional[list[dict[str, str]]] = None,
) -> User:
if user_id in self.users:
raise UserAlreadyExists
if authentication_type not in AuthenticationTypes._value2member_map_:
raise InvalidParameterValueException(
f"Input Authentication type: {authentication_type} is not in the allowed list: [password,no-password-required,iam]"
)
if (
no_password_required
and authentication_type != AuthenticationTypes.NOPASSWORD
):
raise InvalidParameterCombinationException(
f"No password required flag is true but provided authentication type is {authentication_type}"
)
if passwords and authentication_type != AuthenticationTypes.PASSWORD:
raise InvalidParameterCombinationException(
f"Password field is not allowed with authentication type: {authentication_type}"
)
if not passwords and authentication_type == AuthenticationTypes.PASSWORD:
raise InvalidParameterCombinationException(
"A user with Authentication Mode: password, must have at least one password"
)
user = User(
account_id=self.account_id,
region=self.region_name,
user_id=user_id,
user_name=user_name,
engine=engine,
passwords=passwords,
access_string=access_string,
no_password_required=no_password_required,
authentication_type=authentication_type,
tags=tags,
)
if tags:
self.tagging_service.tag_resource(user.arn, tags)
self.users[user_id] = user
return user
def delete_user(self, user_id: str) -> User:
if user_id in self.users:
user = self.users[user_id]
if user.status == "active":
user.status = "deleting"
return user
raise UserNotFound(user_id)
def describe_users(self, user_id: Optional[str]) -> list[User]:
"""
Only the `user_id` parameter is currently supported.
Pagination is not yet implemented.
"""
if user_id:
if user_id in self.users:
user = self.users[user_id]
if user.status == "deleting":
self.users.pop(user_id)
return [user]
else:
raise UserNotFound(user_id)
return list(self.users.values())
def create_cache_cluster(
self,
cache_cluster_id: str,
replication_group_id: str,
az_mode: str,
preferred_availability_zone: str,
num_cache_nodes: int,
cache_node_type: str,
engine: str,
engine_version: str,
cache_parameter_group_name: str,
cache_subnet_group_name: str,
transit_encryption_enabled: bool,
network_type: str,
ip_discovery: str,
snapshot_name: str,
preferred_maintenance_window: str,
port: int,
notification_topic_arn: str,
auto_minor_version_upgrade: bool,
snapshot_retention_limit: int,
snapshot_window: str,
auth_token: str,
outpost_mode: str,
preferred_outpost_arn: str,
preferred_availability_zones: list[str],
cache_security_group_names: list[str],
security_group_ids: list[str],
tags: list[dict[str, str]],
snapshot_arns: list[str],
preferred_outpost_arns: list[str],
log_delivery_configurations: list[dict[str, Any]],
cache_node_ids_to_remove: list[str],
cache_node_ids_to_reboot: list[str],
) -> CacheCluster:
if cache_cluster_id in self.cache_clusters:
raise CacheClusterAlreadyExists(cache_cluster_id)
if cache_node_type is None or cache_node_type == "":
raise InvalidParameterValueException(
"The parameter CacheNodeType must be provided and must not be null."
)
cache_cluster = CacheCluster(
account_id=self.account_id,
region_name=self.region_name,
cache_cluster_id=cache_cluster_id,
replication_group_id=replication_group_id,
az_mode=az_mode,
preferred_availability_zone=preferred_availability_zone,
preferred_availability_zones=preferred_availability_zones,
num_cache_nodes=num_cache_nodes,
cache_node_type=cache_node_type,
engine=engine,
engine_version=engine_version,
cache_parameter_group_name=cache_parameter_group_name,
cache_subnet_group_name=cache_subnet_group_name,
cache_security_group_names=cache_security_group_names,
security_group_ids=security_group_ids,
tags=tags,
snapshot_arns=snapshot_arns,
snapshot_name=snapshot_name,
preferred_maintenance_window=preferred_maintenance_window,
port=port,
notification_topic_arn=notification_topic_arn,
auto_minor_version_upgrade=auto_minor_version_upgrade,
snapshot_retention_limit=snapshot_retention_limit,
snapshot_window=snapshot_window,
auth_token=auth_token,
outpost_mode=outpost_mode,
preferred_outpost_arn=preferred_outpost_arn,
preferred_outpost_arns=preferred_outpost_arns,
log_delivery_configurations=log_delivery_configurations,
transit_encryption_enabled=transit_encryption_enabled,
network_type=network_type,
ip_discovery=ip_discovery,
cache_node_ids_to_remove=cache_node_ids_to_remove,
cache_node_ids_to_reboot=cache_node_ids_to_reboot,
)
if tags:
self.tagging_service.tag_resource(cache_cluster.arn, tags)
self.cache_clusters[cache_cluster_id] = cache_cluster
return cache_cluster
@paginate(PAGINATION_MODEL)
def describe_cache_clusters(
self,
cache_cluster_id: Optional[str] = None,
max_records: Optional[int] = None,
marker: Optional[str] = None,
) -> list[CacheCluster]:
if cache_cluster_id:
if cache_cluster_id in self.cache_clusters:
cache_cluster = self.cache_clusters[cache_cluster_id]
return [cache_cluster]
else:
raise CacheClusterNotFound(cache_cluster_id)
return list(self.cache_clusters.values())
def delete_cache_cluster(self, cache_cluster_id: str) -> CacheCluster:
if cache_cluster_id:
if cache_cluster_id in self.cache_clusters:
cache_cluster = self.cache_clusters[cache_cluster_id]
cache_cluster.cache_cluster_status = "deleting"
return cache_cluster
raise CacheClusterNotFound(cache_cluster_id)
def create_cache_subnet_group(
self,
cache_subnet_group_name: str,
cache_subnet_group_description: str,
subnet_ids: list[str],
tags: Optional[list[dict[str, str]]],
) -> CacheSubnetGroup:
if cache_subnet_group_name in self.cache_subnet_groups:
raise CacheSubnetGroupAlreadyExists(cache_subnet_group_name)
cache_subnet_group = CacheSubnetGroup(
account_id=self.account_id,
region_name=self.region_name,
cache_subnet_group_name=cache_subnet_group_name,
cache_subnet_group_description=cache_subnet_group_description,
subnet_ids=subnet_ids,
tags=tags,
)
if tags:
self.tagging_service.tag_resource(cache_subnet_group.arn, tags)
self.cache_subnet_groups[cache_subnet_group_name] = cache_subnet_group
return cache_subnet_group
@paginate(PAGINATION_MODEL)
def describe_cache_subnet_groups(
self,
cache_subnet_group_name: Optional[str] = None,
) -> list[CacheSubnetGroup]:
if cache_subnet_group_name:
if cache_subnet_group_name in self.cache_subnet_groups:
cache_subnet_group = self.cache_subnet_groups[cache_subnet_group_name]
return [cache_subnet_group]
else:
raise CacheSubnetGroupNotFound(cache_subnet_group_name)
return list(self.cache_subnet_groups.values())
def list_tags_for_resource(self, arn: str) -> dict[str, list[dict[str, str]]]:
if self.arn_regex.match(arn):
return self.tagging_service.list_tags_for_resource(arn)
else:
raise InvalidARNFault(arn)
def add_tags_to_resource(self, arn: str, tags: list[dict[str, str]]) -> None:
# Docs user "ResourceName" as input but the param is technically the ARN, will just use arn
self.tagging_service.tag_resource(arn, tags)
def remove_tags_from_resource(self, arn: str, tags: list[str]) -> None:
# Docs user "ResourceName" as input but the param is technically the ARN, will just use arn
self.tagging_service.untag_resource_using_names(arn, tags)
def create_replication_group(
self,
replication_group_id: str,
replication_group_description: str,
global_replication_group_id: str,
primary_cluster_id: str,
automatic_failover_enabled: bool,
multi_az_enabled: bool,
num_cache_clusters: int,
preferred_cache_cluster_azs: list[str],
num_node_groups: int,
replicas_per_node_group: int,
node_group_configuration: list[dict[str, Any]],
cache_node_type: str,
engine: str,
engine_version: str,
cache_parameter_group_name: str,
cache_subnet_group_name: str,
cache_security_group_names: list[str],
security_group_ids: list[str],
tags: list[dict[str, str]],
snapshot_arns: list[str],
snapshot_name: str,
preferred_maintenance_window: str,
port: int,
notification_topic_arn: str,
auto_minor_version_upgrade: bool,
snapshot_retention_limit: int,
snapshot_window: str,
auth_token: str,
transit_encryption_enabled: bool,
at_rest_encryption_enabled: bool,
kms_key_id: str,
user_group_ids: list[str],
log_delivery_configurations: list[dict[str, Any]],
data_tiering_enabled: bool,
network_type: str,
ip_discovery: str,
transit_encryption_mode: str,
cluster_mode: str,
serverless_cache_snapshot_name: str,
) -> ReplicationGroup:
if replication_group_id in self.replication_groups:
raise ReplicationGroupAlreadyExists(replication_group_id)
replication_group = ReplicationGroup(
account_id=self.account_id,
region_name=self.region_name,
replication_group_id=replication_group_id,
replication_group_description=replication_group_description,
global_replication_group_id=global_replication_group_id,
primary_cluster_id=primary_cluster_id,
automatic_failover_enabled=automatic_failover_enabled,
multi_az_enabled=multi_az_enabled,
num_cache_clusters=num_cache_clusters,
preferred_cache_cluster_azs=preferred_cache_cluster_azs,
num_node_groups=num_node_groups,
replicas_per_node_group=replicas_per_node_group,
node_group_configuration=node_group_configuration,
cache_node_type=cache_node_type,
engine=engine,
engine_version=engine_version,
cache_parameter_group_name=cache_parameter_group_name,
cache_subnet_group_name=cache_subnet_group_name,
cache_security_group_names=cache_security_group_names,
security_group_ids=security_group_ids,
tags=tags,
snapshot_arns=snapshot_arns,
snapshot_name=snapshot_name,
preferred_maintenance_window=preferred_maintenance_window,
port=port,
notification_topic_arn=notification_topic_arn,
auto_minor_version_upgrade=auto_minor_version_upgrade,
snapshot_retention_limit=snapshot_retention_limit,
snapshot_window=snapshot_window,
auth_token=auth_token,
transit_encryption_enabled=transit_encryption_enabled,
at_rest_encryption_enabled=at_rest_encryption_enabled,
kms_key_id=kms_key_id,
user_group_ids=user_group_ids,
log_delivery_configurations=log_delivery_configurations,
data_tiering_enabled=data_tiering_enabled,
network_type=network_type,
ip_discovery=ip_discovery,
transit_encryption_mode=transit_encryption_mode,
cluster_mode=cluster_mode,
serverless_cache_snapshot_name=serverless_cache_snapshot_name,
)
if tags:
self.tagging_service.tag_resource(replication_group.arn, tags)
self.replication_groups[replication_group_id] = replication_group
return replication_group
@paginate(PAGINATION_MODEL)
def describe_replication_groups(
self,
replication_group_id: Optional[str] = None,
) -> list[ReplicationGroup]:
if replication_group_id:
if replication_group_id in self.replication_groups:
replication_group = self.replication_groups[replication_group_id]
return [replication_group]
else:
raise ReplicationGroupNotFound(replication_group_id)
return list(self.replication_groups.values())
def delete_replication_group(
self, replication_group_id: str, retain_primary_cluster: Optional[bool]
) -> ReplicationGroup:
if replication_group_id not in self.replication_groups:
raise ReplicationGroupNotFound(replication_group_id)
replication_group = self.replication_groups[replication_group_id]
replication_group.status = "deleting"
if not retain_primary_cluster:
replication_group = self.replication_groups[replication_group_id]
primary_id = replication_group.primary_cluster_id
if primary_id and primary_id in replication_group.member_clusters:
replication_group.member_clusters.remove(primary_id)
replication_group.primary_cluster_id = ""
return replication_group
def create_snapshot(
self,
snapshot_name: str,
replication_group_id: Optional[str],
cache_cluster_id: Optional[str],
kms_key_id: Optional[str],
tags: Optional[list[dict[str, str]]],
) -> Snapshot:
resource = None
num_node_groups = None
vpc_id = None
if snapshot_name in self.snapshots:
raise SnapshotAlreadyExists(snapshot_name)
if replication_group_id and cache_cluster_id:
raise InvalidParameterCombinationException(
"Only one of CacheClusterId or ReplicationGroupId can be provided."
)
if replication_group_id:
if replication_group_id not in self.replication_groups:
raise ReplicationGroupNotFound(replication_group_id)
resource = self.replication_groups[replication_group_id]
num_node_groups = len(resource.node_groups)
elif cache_cluster_id:
if cache_cluster_id not in self.cache_clusters:
raise CacheClusterNotFound(cache_cluster_id)
resource = self.cache_clusters[cache_cluster_id]
vpc_id = self._get_vpc_id_from_cluster(cache_cluster_id)
else:
raise InvalidParameterValueException(
"One of CacheClusterId or ReplicationGroupId must be provided."
)
snapshot = Snapshot(
account_id=self.account_id,
region_name=self.region_name,
automatic_failover=getattr(resource, "automatic_failover", None),
auto_minor_version_upgrade=getattr(
resource, "auto_minor_version_upgrade", None
),
cache_cluster_create_time=getattr(
resource, "cache_cluster_create_time", None
),
cache_cluster_id=getattr(resource, "cache_cluster_id", None),
cache_node_type=getattr(resource, "cache_node_type", None),
cache_parameter_group_name=getattr(
resource, "cache_parameter_group_name", None
),
cache_subnet_group_name=getattr(resource, "cache_subnet_group_name", None),
engine=getattr(resource, "engine", None),
engine_version=getattr(resource, "engine_version", None),
kms_key_id=kms_key_id,
num_cache_nodes=getattr(resource, "num_cache_nodes", None),
num_node_groups=num_node_groups,
port=getattr(resource, "port", None),
preferred_availability_zone=getattr(
resource, "preferred_availability_zone", None
),
preferred_maintenance_window=getattr(
resource, "preferred_maintenance_window", None
),
preferred_outpost_arn=getattr(resource, "preferred_outpost_arn", None),
replication_group_description=getattr(resource, "description", None),
replication_group_id=getattr(resource, "replication_group_id", None),
snapshot_name=snapshot_name,
snapshot_retention_limit=getattr(
resource, "snapshot_retention_limit", None
),
snapshot_status="available",
snapshot_source="manual",
snapshot_window=getattr(resource, "snapshot_window", None),
topic_arn=getattr(resource, "notification_topic_arn", None),
tags=tags or [],
vpc_id=vpc_id,
)
if tags:
self.tagging_service.tag_resource(snapshot.arn, tags)
self.snapshots[snapshot_name] = snapshot
return snapshot
def describe_snapshots(
self,
replication_group_id: Optional[str] = None,
cache_cluster_id: Optional[str] = None,
snapshot_name: Optional[str] = None,
snapshot_source: Optional[str] = None,
marker: Optional[str] = None,
max_records: Optional[int] = None,
show_node_group_config: Optional[bool] = None,
) -> list[Snapshot]:
if snapshot_name:
try:
return [self.snapshots[snapshot_name]]
except KeyError:
raise SnapshotNotFound(snapshot_name)
if replication_group_id and cache_cluster_id:
raise InvalidParameterCombinationException(
"Only one of CacheClusterId or ReplicationGroupId can be provided."
)
if replication_group_id and replication_group_id not in self.replication_groups:
raise ReplicationGroupNotFound(replication_group_id)
if cache_cluster_id and cache_cluster_id not in self.cache_clusters:
raise CacheClusterNotFound(cache_cluster_id)
ref_id = replication_group_id or cache_cluster_id
if snapshot_source or ref_id:
return self._get_snapshots_by_param(ref_id=ref_id, source=snapshot_source)
return list(self.snapshots.values())
def delete_snapshot(self, snapshot_name: str) -> Snapshot:
if snapshot_name in self.snapshots:
snapshot = self.snapshots[snapshot_name]
snapshot.snapshot_status = "deleting"
self.snapshots.pop(snapshot_name)
return snapshot
raise SnapshotNotFound(snapshot_name)
elasticache_backends = BackendDict(ElastiCacheBackend, "elasticache")
|