awslabs.elasticache-mcp-server 0.1.1__py3-none-any.whl

awslabs/elasticache_mcp_server/tools/misc/batch_apply_update_action.py

@@ -0,0 +1,62 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Batch apply update action tool for ElastiCache MCP server."""
+
+from ...common.connection import ElastiCacheConnectionManager
+from ...common.decorators import handle_exceptions
+from ...common.server import mcp
+from ...context import Context
+from typing import Dict, List, Optional
+
+
+@mcp.tool(name='batch-apply-update-action')
+@handle_exceptions
+async def batch_apply_update_action(
+    service_update_name: str,
+    replication_group_ids: Optional[List[str]] = None,
+    cache_cluster_ids: Optional[List[str]] = None,
+) -> Dict:
+    """Apply 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.
+    """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        raise ValueError(
+            'You have configured this tool in readonly mode. To make this change you will have to update your configuration.'
+        )
+
+    # Get ElastiCache client
+    elasticache_client = ElastiCacheConnectionManager.get_connection()
+
+    # Build request
+    request: Dict[str, str | List[str]] = {'ServiceUpdateName': service_update_name}
+
+    if replication_group_ids:
+        request['ReplicationGroupIds'] = replication_group_ids
+    if cache_cluster_ids:
+        request['CacheClusterIds'] = cache_cluster_ids
+
+    # Apply the service update
+    response = elasticache_client.batch_apply_update_action(**request)
+    return response

awslabs/elasticache_mcp_server/tools/misc/batch_stop_update_action.py

@@ -0,0 +1,62 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Batch stop update action tool for ElastiCache MCP server."""
+
+from ...common.connection import ElastiCacheConnectionManager
+from ...common.decorators import handle_exceptions
+from ...common.server import mcp
+from ...context import Context
+from typing import Dict, List, Optional
+
+
+@mcp.tool(name='batch-stop-update-action')
+@handle_exceptions
+async def batch_stop_update_action(
+    service_update_name: str,
+    replication_group_ids: Optional[List[str]] = None,
+    cache_cluster_ids: Optional[List[str]] = None,
+) -> Dict:
+    """Stop 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.
+    """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        raise ValueError(
+            'You have configured this tool in readonly mode. To make this change you will have to update your configuration.'
+        )
+
+    # Get ElastiCache client
+    elasticache_client = ElastiCacheConnectionManager.get_connection()
+
+    # Build request
+    request: Dict[str, str | List[str]] = {'ServiceUpdateName': service_update_name}
+
+    if replication_group_ids:
+        request['ReplicationGroupIds'] = replication_group_ids
+    if cache_cluster_ids:
+        request['CacheClusterIds'] = cache_cluster_ids
+
+    # Stop the service update
+    response = elasticache_client.batch_stop_update_action(**request)
+    return response

awslabs/elasticache_mcp_server/tools/misc/describe_cache_engine_versions.py

@@ -0,0 +1,79 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Describe cache engine versions tool for ElastiCache MCP server."""
+
+from ...common.connection import ElastiCacheConnectionManager
+from ...common.decorators import handle_exceptions
+from ...common.server import mcp
+from typing import Dict, Optional
+
+
+@mcp.tool(name='describe-cache-engine-versions')
+@handle_exceptions
+async def describe_cache_engine_versions(
+    engine: Optional[str] = None,
+    engine_version: Optional[str] = None,
+    cache_parameter_group_family: Optional[str] = None,
+    max_records: Optional[int] = None,
+    marker: Optional[str] = None,
+    default_only: Optional[bool] = None,
+) -> Dict:
+    """Returns 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
+    """
+    # Get ElastiCache client
+    elasticache_client = ElastiCacheConnectionManager.get_connection()
+
+    # Build describe request
+    describe_request = {}
+
+    # Add optional parameters if provided
+    if engine:
+        describe_request['Engine'] = engine
+    if engine_version:
+        describe_request['EngineVersion'] = engine_version
+    if cache_parameter_group_family:
+        describe_request['CacheParameterGroupFamily'] = cache_parameter_group_family
+    if max_records:
+        describe_request['MaxRecords'] = max_records
+    if marker:
+        describe_request['Marker'] = marker
+    if default_only is not None:
+        describe_request['DefaultOnly'] = default_only
+
+    # Describe the cache engine versions
+    response = elasticache_client.describe_cache_engine_versions(**describe_request)
+    return response

awslabs/elasticache_mcp_server/tools/misc/describe_engine_default_parameters.py

@@ -0,0 +1,64 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Describe engine default parameters tool for ElastiCache MCP server."""
+
+from ...common.connection import ElastiCacheConnectionManager
+from ...common.decorators import handle_exceptions
+from ...common.server import mcp
+from typing import Dict, Optional
+
+
+@mcp.tool(name='describe-engine-default-parameters')
+@handle_exceptions
+async def describe_engine_default_parameters(
+    cache_parameter_group_family: str,
+    max_records: Optional[int] = None,
+    marker: Optional[str] = None,
+) -> Dict:
+    """Returns 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
+    """
+    # Get ElastiCache client
+    elasticache_client = ElastiCacheConnectionManager.get_connection()
+
+    # Build describe request
+    describe_request = {'CacheParameterGroupFamily': cache_parameter_group_family}
+
+    # Add optional parameters if provided
+    if max_records is not None:
+        describe_request['MaxRecords'] = str(max_records)
+    if marker:
+        describe_request['Marker'] = marker
+
+    # Describe the engine default parameters
+    response = elasticache_client.describe_engine_default_parameters(**describe_request)
+    return response

awslabs/elasticache_mcp_server/tools/misc/describe_events.py

@@ -0,0 +1,86 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Describe events tool for ElastiCache MCP server."""
+
+from ...common.connection import ElastiCacheConnectionManager
+from ...common.decorators import handle_exceptions
+from ...common.server import mcp
+from datetime import datetime
+from typing import Dict, Optional
+
+
+@mcp.tool(name='describe-events')
+@handle_exceptions
+async def describe_events(
+    source_type: Optional[str] = None,
+    source_identifier: Optional[str] = None,
+    start_time: Optional[datetime] = None,
+    end_time: Optional[datetime] = None,
+    duration: Optional[int] = None,
+    max_records: Optional[int] = None,
+    marker: Optional[str] = None,
+) -> Dict:
+    """Returns 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
+    """
+    # Get ElastiCache client
+    elasticache_client = ElastiCacheConnectionManager.get_connection()
+
+    # Build describe request
+    describe_request = {}
+
+    # Add optional parameters if provided
+    if source_type:
+        describe_request['SourceType'] = source_type
+    if source_identifier:
+        describe_request['SourceIdentifier'] = source_identifier
+    if start_time:
+        describe_request['StartTime'] = start_time
+    if end_time:
+        describe_request['EndTime'] = end_time
+    if duration:
+        describe_request['Duration'] = duration
+    if max_records:
+        describe_request['MaxRecords'] = max_records
+    if marker:
+        describe_request['Marker'] = marker
+
+    # Describe the events
+    response = elasticache_client.describe_events(**describe_request)
+    return response

awslabs/elasticache_mcp_server/tools/misc/describe_service_updates.py

@@ -0,0 +1,71 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Describe service updates tool for ElastiCache MCP server."""
+
+from ...common.connection import ElastiCacheConnectionManager
+from ...common.decorators import handle_exceptions
+from ...common.server import mcp
+from typing import Dict, List, Optional
+
+
+@mcp.tool(name='describe-service-updates')
+@handle_exceptions
+async def describe_service_updates(
+    service_update_name: Optional[str] = None,
+    service_update_status: Optional[List[str]] = None,
+    starting_token: Optional[str] = None,
+    page_size: Optional[int] = None,
+    max_items: Optional[int] = None,
+) -> Dict:
+    """Returns 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
+    """
+    # Get ElastiCache client
+    elasticache_client = ElastiCacheConnectionManager.get_connection()
+
+    # Build describe request
+    describe_request = {}
+
+    # Add optional parameters if provided
+    if service_update_name:
+        describe_request['ServiceUpdateName'] = service_update_name
+    if service_update_status:
+        describe_request['ServiceUpdateStatus'] = service_update_status
+    if starting_token:
+        describe_request['Marker'] = starting_token
+    if page_size:
+        describe_request['MaxRecords'] = page_size
+    if max_items:
+        describe_request['MaxItems'] = max_items
+
+    # Describe the service updates
+    response = elasticache_client.describe_service_updates(**describe_request)
+    return response

awslabs/elasticache_mcp_server/tools/rg/__init__.py

@@ -0,0 +1,54 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Replication group tools for ElastiCache MCP server."""
+
+from .create import create_replication_group
+from .connect import create_jump_host_rg, connect_jump_host_rg, get_ssh_tunnel_command_rg
+from .delete import delete_replication_group
+from .describe import describe_replication_groups
+from .modify import modify_replication_group, modify_replication_group_shard_configuration
+from .test_migration import test_migration
+from .start_migration import start_migration
+from .complete_migration import complete_migration
+from .parsers import (
+    parse_shorthand_nodegroup,
+    parse_shorthand_log_delivery,
+    parse_shorthand_resharding,
+)
+from .processors import (
+    process_log_delivery_configurations,
+    process_nodegroup_configuration,
+    process_resharding_configuration,
+)
+
+__all__ = [
+    'connect_jump_host_rg',
+    'create_jump_host_rg',
+    'create_replication_group',
+    'delete_replication_group',
+    'describe_replication_groups',
+    'get_ssh_tunnel_command_rg',
+    'modify_replication_group',
+    'modify_replication_group_shard_configuration',
+    'parse_shorthand_nodegroup',
+    'parse_shorthand_log_delivery',
+    'parse_shorthand_resharding',
+    'process_log_delivery_configurations',
+    'process_nodegroup_configuration',
+    'process_resharding_configuration',
+    'test_migration',
+    'start_migration',
+    'complete_migration',
+]

awslabs/elasticache_mcp_server/tools/rg/complete_migration.py

@@ -0,0 +1,94 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Complete migration tool for ElastiCache MCP server."""
+
+from ...common.connection import ElastiCacheConnectionManager
+from ...common.decorators import handle_exceptions
+from ...common.server import mcp
+from ...context import Context
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, Dict, Optional
+
+
+class CompleteMigrationRequest(BaseModel):
+    """Request model for completing migration to an ElastiCache replication group."""
+
+    model_config = ConfigDict(validate_by_name=True, arbitrary_types_allowed=True)
+
+    replication_group_id: str = Field(
+        ..., description='The ID of the replication group to which data is being migrated'
+    )
+    force: Optional[bool] = Field(
+        None,
+        description='Forces the migration to stop without ensuring that data is in sync. '
+        'It is recommended to use this option only to abort the migration and not recommended '
+        'when application wants to continue migration to ElastiCache.',
+    )
+
+
+def prepare_request_dict(request: CompleteMigrationRequest) -> Dict[str, Any]:
+    """Prepare the request dictionary for the AWS API.
+
+    Args:
+        request: The CompleteMigrationRequest object
+
+    Returns:
+        Dict containing the properly formatted request parameters
+    """
+    # Start with required parameters
+    complete_migration_request: Dict[str, Any] = {
+        'ReplicationGroupId': request.replication_group_id,
+    }
+
+    # Add optional force parameter if provided
+    if request.force is not None:
+        complete_migration_request['Force'] = request.force
+
+    return complete_migration_request
+
+
+@mcp.tool(name='complete-migration')
+@handle_exceptions
+async def complete_migration(request: CompleteMigrationRequest) -> Dict:
+    """Complete 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.
+
+    Args:
+        request: The CompleteMigrationRequest object containing:
+            - replication_group_id: The ID of the replication group to which data is being migrated
+            - force: (Optional) Forces the migration to stop without ensuring that data is in sync.
+              It is recommended to use this option only to abort the migration and not recommended
+              when application wants to continue migration to ElastiCache.
+
+    Returns:
+        Dict containing information about the migration completion result.
+    """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        raise ValueError(
+            'You have configured this tool in readonly mode. To make this change you will have to update your configuration.'
+        )
+
+    # Get ElastiCache client
+    elasticache_client = ElastiCacheConnectionManager.get_connection()
+
+    # Prepare request dictionary
+    complete_request = prepare_request_dict(request)
+
+    # Complete the migration
+    response = elasticache_client.complete_migration(**complete_request)
+    return response