Amazon ElastiCache

Amazon ElastiCache

ElastiCache control plane operations.

10K+

39 Tools

Packaged by
Add to Docker Desktop

Version 4.43 or later needs to be installed to add the server automatically

Tools

NameDescription
batch-apply-update-actionApply service update to multiple ElastiCache resources. Parameters: service_update_name (str): The unique ID of the service update to apply. replication_group_ids (Optional[List[str]]): List of replication group IDs to update. Either this or cache_cluster_ids must be provided. cache_cluster_ids (Optional[List[str]]): List of cache cluster IDs to update. Either this or replication_group_ids must be provided. Returns: Dict containing information about the batch update operation.
batch-stop-update-actionStop service update for multiple ElastiCache resources. Parameters: service_update_name (str): The unique ID of the service update to stop. replication_group_ids (Optional[List[str]]): List of replication group IDs to stop update. Either this or cache_cluster_ids must be provided. cache_cluster_ids (Optional[List[str]]): List of cache cluster IDs to stop update. Either this or replication_group_ids must be provided. Returns: Dict containing information about the batch stop operation.
complete-migrationComplete migration to an Amazon ElastiCache replication group. This tool completes the migration of data from a Redis instance to an ElastiCache replication group. It finalizes the data migration process and transitions the replication group to normal operation.
connect-jump-host-cache-clusterConfigures an existing EC2 instance as a jump host to access an ElastiCache cluster.
connect-jump-host-replication-groupConfigures an existing EC2 instance as a jump host to access an ElastiCache replication group.
connect-jump-host-serverless-cacheConfigures an existing EC2 instance as a jump host to access an ElastiCache serverless cache.
create-cache-clusterCreate an Amazon ElastiCache cache cluster.
create-jump-host-cache-clusterCreates an EC2 jump host instance to access an ElastiCache cluster via SSH tunnel.
create-jump-host-replication-groupCreates an EC2 jump host instance to access an ElastiCache replication group via SSH tunnel.
create-jump-host-serverless-cacheCreates an EC2 jump host instance to access an ElastiCache serverless cache via SSH tunnel.
create-log-groupCreate a new CloudWatch Logs log group.
create-replication-groupCreate an Amazon ElastiCache replication group. This tool creates a new replication group with specified configuration including: - Basic replication group settings - Cache node configuration - Network and security settings - Encryption settings - Backup and maintenance settings - Monitoring and logging settings
create-serverless-cacheCreate a new Amazon ElastiCache serverless cache. This tool creates a new serverless cache with specified configuration including: - Serverless cache name and capacity - Optional VPC and security settings - Optional encryption settings - Optional snapshot restoration and backup settings - Optional usage limits and user groups - Optional tags Parameters: serverless_cache_name (str): Name of the serverless cache. engine (str): Cache engine type. description (Optional[str]): Description for the cache. kms_key_id (Optional[str]): KMS key ID for encryption. major_engine_version (Optional[str]): Major engine version. snapshot_arns_to_restore (Optional[List[str]]): List of snapshot ARNs to restore from. subnet_ids (Optional[List[str]]): List of subnet IDs for VPC configuration. tags (Optional[Union[str, List[Dict[str, Optional[str]]], Dict[str, Optional[str]]]]): Tags to apply to the cache. Tag requirements: - Key: (string) Required. The key for the tag. Must not be empty. - Value: (string) Optional. The tag's value. May be null. Supports three formats: 1. Shorthand syntax: "Key=value,Key2=value2" or "Key=,Key2=" for null values 2. Dictionary: {"key": "value", "key2": null} 3. JSON array: [{"Key": "string", "Value": "string"}, {"Key": "string2", "Value": null}] Can be None if no tags are needed. security_group_ids (Optional[List[str]]): List of security group IDs. cache_usage_limits (Optional[CacheUsageLimits]): Usage limits for the cache. Structure: { "DataStorage": { "Maximum": int, # Maximum storage in GB "Minimum": int, # Minimum storage in GB "Unit": "GB" # Storage unit (currently only GB is supported) }, "ECPUPerSecond": { "Maximum": int, # Maximum ECPU per second "Minimum": int # Minimum ECPU per second } } user_group_id (Optional[str]): ID of the user group to associate with the cache. snapshot_retention_limit (Optional[int]): Number of days for which ElastiCache retains automatic snapshots. daily_snapshot_time (Optional[str]): Time range (in UTC) when daily snapshots are taken (e.g., '04:00-05:00'). Returns: Dict containing information about the created serverless cache.
delete-cache-clusterDelete an Amazon ElastiCache cache cluster. This tool deletes an existing cache cluster. Optionally, it can create a final snapshot of the cluster before deletion. Parameters: cache_cluster_id (str): The ID of the cache cluster to delete. final_snapshot_identifier (Optional[str]): The user-supplied name of a final cache cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cache cluster immediately afterward. Returns: Dict containing information about the deleted cache cluster.
delete-replication-groupDelete an Amazon ElastiCache replication group. This tool deletes an existing replication group. You can optionally retain the primary cluster as a standalone cache cluster or create a final snapshot before deletion. Parameters: replication_group_id (str): The identifier of the replication group to delete. retain_primary_cluster (Optional[bool]): If True, retains the primary cluster as a standalone cache cluster. If False, deletes all clusters in the replication group. final_snapshot_name (Optional[str]): The name of a final cache cluster snapshot to create before deleting the replication group. Returns: Dict containing information about the deleted replication group.
delete-serverless-cacheDelete an Amazon ElastiCache serverless cache. This tool deletes a specified serverless cache from your AWS account. The cache must exist and be in a deletable state. Parameters: serverless_cache_name (str): Name of the serverless cache to delete. final_snapshot_name (Optional[str]): Name of the final snapshot to create before deletion. Returns: Dict containing the deletion response or error information.
describe-cache-clustersDescribe one or more ElastiCache cache clusters. This tool returns information about provisioned cache clusters. If a cache cluster ID is specified, information about only that cache cluster is returned. Otherwise, information about up to MaxRecords cache clusters is returned. Parameters: cache_cluster_id (Optional[str]): The identifier for the cache cluster to describe. If not provided, information about all cache clusters is returned. max_records (Optional[int]): The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. marker (Optional[str]): An optional marker returned from a previous request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. show_cache_node_info (Optional[bool]): Whether to include detailed information about cache nodes in the response. show_cache_clusters_not_in_replication_groups (Optional[bool]): Whether to show only cache clusters that are not members of a replication group. Returns: Dict containing information about the cache cluster(s), including: - CacheClusters: List of cache clusters - Marker: Pagination marker for next set of results
describe-cache-engine-versionsReturns a list of the available cache engines and their versions. Parameters: engine (Optional[str]): The cache engine to return. Valid values: memcached | redis | valkey engine_version (Optional[str]): The cache engine version to return. Example: memcached 1.4.14, redis 6.x, valkey 8.0 cache_parameter_group_family (Optional[str]): The name of a specific cache parameter group family. Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7.x | valkey7.x | valkey8.x max_records (Optional[int]): The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. marker (Optional[str]): An optional marker returned from a previous request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. default_only (Optional[bool]): If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned. Returns: Dict containing information about the cache engine versions, including: - CacheEngineVersions: List of cache engine versions - Marker: Pagination marker for next set of results
describe-engine-default-parametersReturns the default engine and system parameter information for the specified cache engine family. Parameters: cache_parameter_group_family (str): The name of the cache parameter group family. Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7.x | valkey7.x | valkey8.x max_records (Optional[int]): The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. marker (Optional[str]): An optional marker returned from a previous request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. Returns: Dict containing information about the engine default parameters, including: - Parameters: List of parameters with their details - CacheParameterGroupFamily: The name of the cache parameter group family - Marker: Pagination marker for next set of results
describe-eventsReturns events related to clusters, cache security groups, and parameter groups. Parameters: source_type (Optional[str]): The event source to retrieve events for. If not specified, all events are returned. Valid values: cache-cluster | cache-parameter-group | cache-security-group | cache-subnet-group | replication-group | user | user-group source_identifier (Optional[str]): The identifier of the event source for which events are returned. For example, if source_type is cache-cluster, you can specify a cluster identifier to see all events for only that cluster. start_time (Optional[datetime]): The beginning of the time interval to retrieve events for, specified in ISO 8601 format. end_time (Optional[datetime]): The end of the time interval to retrieve events for, specified in ISO 8601 format. duration (Optional[int]): The number of minutes worth of events to retrieve. max_records (Optional[int]): The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. marker (Optional[str]): An optional marker returned from a previous request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. Returns: Dict containing information about the events, including: - Events: List of events - Marker: Pagination marker for next set of results
describe-log-groupsDescribe CloudWatch Logs log groups.
describe-log-streamsDescribe CloudWatch Logs log streams.
describe-replication-groupsDescribe one or more ElastiCache replication groups. This tool returns information about provisioned replication groups. If a replication group ID is specified, information about only that replication group is returned. Otherwise, information about up to MaxRecords replication groups is returned. Parameters: replication_group_id (Optional[str]): The identifier for the replication group to describe. If not provided, information about all replication groups is returned. max_records (Optional[int]): The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. marker (Optional[str]): An optional marker returned from a previous request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. Returns: Dict containing information about the replication group(s), including: - ReplicationGroups: List of replication groups - Marker: Pagination marker for next set of results
describe-serverless-cachesDescribe Amazon ElastiCache serverless caches in your AWS account. This tool retrieves detailed information about serverless caches including: - Cache configuration - Cache endpoints - Cache status - Cache size - Cache connections Parameters: serverless_cache_name (Optional[str]): Name of the serverless cache to describe. If not provided, describes all caches. max_items (Optional[int]): Maximum number of results to return. starting_token (Optional[str]): Token to start the list from a specific page. page_size (Optional[int]): Number of records to include in each page. Returns: Dict containing information about the serverless cache(s).
describe-service-updatesReturns details of the service updates. Parameters: service_update_name (Optional[str]): The unique ID of the service update to describe. service_update_status (Optional[List[str]]): List of status values to filter by. Valid values: available | cancelled | expired | complete starting_token (Optional[str]): An optional token returned from a previous request. Use this token for pagination of results from this operation. page_size (Optional[int]): The maximum number of records to include in each page of results. max_items (Optional[int]): The maximum number of records to include in the response. If more records exist than the specified MaxItems value, a marker is included in the response so that the remaining results can be retrieved. Returns: Dict containing information about the service updates, including: - ServiceUpdates: List of service updates - NextToken: Token for next set of results
filter-log-eventsFilter log events from CloudWatch Logs.
get-cost-and-usageGet cost and usage data for ElastiCache resources. This tool retrieves cost and usage data for ElastiCache resources with customizable time periods and granularity. It uses default configurations for: - Metrics: BlendedCost, UnblendedCost, UsageQuantity - Group By: SERVICE dimension and Environment tag - Filter: Filtered to Amazon ElastiCache service
get-log-eventsGet log events from CloudWatch Logs.
get-metric-statisticsGet CloudWatch metric statistics.
get-ssh-tunnel-command-cache-clusterGenerates an SSH tunnel command to connect to an ElastiCache cluster through an EC2 jump host.
get-ssh-tunnel-command-replication-groupGenerates an SSH tunnel command to connect to an ElastiCache replication group through an EC2 jump host.
get-ssh-tunnel-command-serverless-cacheGenerates an SSH tunnel command to connect to an ElastiCache serverless cache through an EC2 jump host.
list-delivery-streamsList your delivery streams.
modify-cache-clusterModify an existing Amazon ElastiCache cache cluster.
modify-replication-groupModify an existing Amazon ElastiCache replication group. This tool modifies the settings of an existing replication group including: - Node configuration - Security settings - Maintenance settings - Backup settings - Engine settings - Monitoring settings - User group settings
modify-replication-group-shard-configurationModify the shard configuration of an existing Amazon ElastiCache replication group. This tool modifies the shard configuration of an existing replication group by: - Modifying the number of replicas in a shard - Specifying preferred availability zones for replicas Parameters: replication_group_id (str): The identifier of the replication group to modify. node_group_count (int): The number of node groups (shards) in the replication group. apply_immediately (Optional[bool]): Whether to apply changes immediately or during maintenance window. resharding_configuration (Optional[Union[str, List[Dict]]]): Resharding configuration in either shorthand string format or list of dictionaries format. Shorthand format: "NodeGroupId=string,NewShardConfiguration={NewReplicaCount=integer,PreferredAvailabilityZones=string1,string2}" Multiple configurations can be separated by spaces. JSON format: List of dictionaries with required fields: - NodeGroupId: string - NewShardConfiguration: - NewReplicaCount: integer - PreferredAvailabilityZones: list of strings (optional) Returns: Dict containing information about the modified replication group.
modify-serverless-cacheModify an Amazon ElastiCache serverless cache. This tool modifies the configuration of an existing serverless cache including: - Cache description - Engine version - Snapshot settings - Usage limits - Security groups - User groups Parameters: serverless_cache_name (str): Name of the serverless cache to modify. apply_immediately (Optional[bool]): Whether to apply changes immediately or during maintenance window. description (Optional[str]): New description for the cache. major_engine_version (Optional[str]): New major engine version. snapshot_retention_limit (Optional[int]): Number of days for which ElastiCache retains automatic snapshots. daily_snapshot_time (Optional[str]): Time range (in UTC) when daily snapshots are taken (e.g., '04:00-05:00'). cache_usage_limits (Optional[CacheUsageLimits]): New usage limits for the cache. Structure: { "DataStorage": { "Maximum": int, # Maximum storage in GB "Minimum": int, # Minimum storage in GB "Unit": "GB" # Storage unit (currently only GB is supported) }, "ECPUPerSecond": { "Maximum": int, # Maximum ECPU per second "Minimum": int # Minimum ECPU per second } } security_group_ids (Optional[List[str]]): List of security group IDs. user_group_id (Optional[str]): ID of the user group to associate with the cache. Returns: Dict containing information about the modified serverless cache.
start-migrationStart migration to an Amazon ElastiCache replication group. This tool starts migration from a Redis instance to an ElastiCache replication group. It initiates the data migration process from the specified endpoint(s) to the target replication group.
test-migrationTest migration to an Amazon ElastiCache replication group. This tool tests migration from a Redis instance to an ElastiCache replication group. It validates that data can be successfully migrated from the specified endpoint to the target replication group.
Related servers