ElastiCache / Client / delete_serverless_cache

delete_serverless_cache#

ElastiCache.Client.delete_serverless_cache(**kwargs)#

Deletes a specified existing serverless cache.

See also: AWS API Documentation

Request Syntax

response = client.delete_serverless_cache(
    ServerlessCacheName='string',
    FinalSnapshotName='string'
)
Parameters:
  • ServerlessCacheName (string) –

    [REQUIRED]

    The identifier of the serverless cache to be deleted.

  • FinalSnapshotName (string) – Name of the final snapshot to be taken before the serverless cache is deleted. Available for Redis only. Default: NULL, i.e. a final snapshot is not taken.

Return type:

dict

Returns:

Response Syntax

{
    'ServerlessCache': {
        'ServerlessCacheName': 'string',
        'Description': 'string',
        'CreateTime': datetime(2015, 1, 1),
        'Status': 'string',
        'Engine': 'string',
        'MajorEngineVersion': 'string',
        'FullEngineVersion': 'string',
        'CacheUsageLimits': {
            'DataStorage': {
                'Maximum': 123,
                'Unit': 'GB'
            },
            'ECPUPerSecond': {
                'Maximum': 123
            }
        },
        'KmsKeyId': 'string',
        'SecurityGroupIds': [
            'string',
        ],
        'Endpoint': {
            'Address': 'string',
            'Port': 123
        },
        'ReaderEndpoint': {
            'Address': 'string',
            'Port': 123
        },
        'ARN': 'string',
        'UserGroupId': 'string',
        'SubnetIds': [
            'string',
        ],
        'SnapshotRetentionLimit': 123,
        'DailySnapshotTime': 'string'
    }
}

Response Structure

  • (dict) –

    • ServerlessCache (dict) –

      Provides the details of the specified serverless cache that is about to be deleted.

      • ServerlessCacheName (string) –

        The unique identifier of the serverless cache.

      • Description (string) –

        A description of the serverless cache.

      • CreateTime (datetime) –

        When the serverless cache was created.

      • Status (string) –

        The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.

      • Engine (string) –

        The engine the serverless cache is compatible with.

      • MajorEngineVersion (string) –

        The version number of the engine the serverless cache is compatible with.

      • FullEngineVersion (string) –

        The name and version number of the engine the serverless cache is compatible with.

      • CacheUsageLimits (dict) –

        The cache usage limit for the serverless cache.

        • DataStorage (dict) –

          The maximum data storage limit in the cache, expressed in Gigabytes.

          • Maximum (integer) –

            The upper limit for data storage the cache is set to use.

          • Unit (string) –

            The unit that the storage is measured in, in GB.

        • ECPUPerSecond (dict) –

          The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second.

          • Maximum (integer) –

            The configuration for the maximum number of ECPUs the cache can consume per second.

      • KmsKeyId (string) –

        The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.

      • SecurityGroupIds (list) –

        The IDs of the EC2 security groups associated with the serverless cache.

        • (string) –

      • Endpoint (dict) –

        Represents the information required for client programs to connect to a cache node. This value is read-only.

        • Address (string) –

          The DNS hostname of the cache node.

        • Port (integer) –

          The port number that the cache engine is listening on.

      • ReaderEndpoint (dict) –

        Represents the information required for client programs to connect to a cache node. This value is read-only.

        • Address (string) –

          The DNS hostname of the cache node.

        • Port (integer) –

          The port number that the cache engine is listening on.

      • ARN (string) –

        The Amazon Resource Name (ARN) of the serverless cache.

      • UserGroupId (string) –

        The identifier of the user group associated with the serverless cache. Available for Redis only. Default is NULL.

      • SubnetIds (list) –

        If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC. For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.

        • (string) –

      • SnapshotRetentionLimit (integer) –

        The current setting for the number of serverless cache snapshots the system will retain. Available for Redis only.

      • DailySnapshotTime (string) –

        The daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a specific time on a daily basis. Available for Redis only.

Exceptions

  • ElastiCache.Client.exceptions.ServerlessCacheNotFoundFault

  • ElastiCache.Client.exceptions.InvalidServerlessCacheStateFault

  • ElastiCache.Client.exceptions.ServerlessCacheSnapshotAlreadyExistsFault

  • ElastiCache.Client.exceptions.InvalidParameterValueException

  • ElastiCache.Client.exceptions.InvalidParameterCombinationException

  • ElastiCache.Client.exceptions.InvalidCredentialsException

  • ElastiCache.Client.exceptions.ServiceLinkedRoleNotFoundFault