ElastiCache / Client / create_serverless_cache_snapshot

create_serverless_cache_snapshot#

ElastiCache.Client.create_serverless_cache_snapshot(**kwargs)#

This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis only.

See also: AWS API Documentation

Request Syntax

response = client.create_serverless_cache_snapshot(
    ServerlessCacheSnapshotName='string',
    ServerlessCacheName='string',
    KmsKeyId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • ServerlessCacheSnapshotName (string) –

    [REQUIRED]

    The name for the snapshot being created. Must be unique for the customer account. Available for Redis only. Must be between 1 and 255 characters.

  • ServerlessCacheName (string) –

    [REQUIRED]

    The name of an existing serverless cache. The snapshot is created from this cache. Available for Redis only.

  • KmsKeyId (string) – The ID of the KMS key used to encrypt the snapshot. Available for Redis only. Default: NULL

  • Tags (list) –

    A list of tags to be added to the snapshot resource. A tag is a key-value pair. Available for Redis only.

    • (dict) –

      A tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.

      • Key (string) –

        The key for the tag. May not be null.

      • Value (string) –

        The tag’s value. May be null.

Return type:

dict

Returns:

Response Syntax

{
    'ServerlessCacheSnapshot': {
        'ServerlessCacheSnapshotName': 'string',
        'ARN': 'string',
        'KmsKeyId': 'string',
        'SnapshotType': 'string',
        'Status': 'string',
        'CreateTime': datetime(2015, 1, 1),
        'ExpiryTime': datetime(2015, 1, 1),
        'BytesUsedForCache': 'string',
        'ServerlessCacheConfiguration': {
            'ServerlessCacheName': 'string',
            'Engine': 'string',
            'MajorEngineVersion': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • ServerlessCacheSnapshot (dict) –

      The state of a serverless cache snapshot at a specific point in time, to the millisecond. Available for Redis only.

      • ServerlessCacheSnapshotName (string) –

        The identifier of a serverless cache snapshot. Available for Redis only.

      • ARN (string) –

        The Amazon Resource Name (ARN) of a serverless cache snapshot. Available for Redis only.

      • KmsKeyId (string) –

        The ID of the Amazon Web Services Key Management Service (KMS) key of a serverless cache snapshot. Available for Redis only.

      • SnapshotType (string) –

        The type of snapshot of serverless cache. Available for Redis only.

      • Status (string) –

        The current status of the serverless cache. Available for Redis only.

      • CreateTime (datetime) –

        The date and time that the source serverless cache’s metadata and cache data set was obtained for the snapshot. Available for Redis only.

      • ExpiryTime (datetime) –

        The time that the serverless cache snapshot will expire. Available for Redis only.

      • BytesUsedForCache (string) –

        The total size of a serverless cache snapshot, in bytes. Available for Redis only.

      • ServerlessCacheConfiguration (dict) –

        The configuration of the serverless cache, at the time the snapshot was taken. Available for Redis only.

        • ServerlessCacheName (string) –

          The identifier of a serverless cache.

        • Engine (string) –

          The engine that the serverless cache is configured with.

        • MajorEngineVersion (string) –

          The engine version number that the serverless cache is configured with.

Exceptions

  • ElastiCache.Client.exceptions.ServerlessCacheSnapshotAlreadyExistsFault

  • ElastiCache.Client.exceptions.ServerlessCacheNotFoundFault

  • ElastiCache.Client.exceptions.InvalidServerlessCacheStateFault

  • ElastiCache.Client.exceptions.ServerlessCacheSnapshotQuotaExceededFault

  • ElastiCache.Client.exceptions.ServiceLinkedRoleNotFoundFault

  • ElastiCache.Client.exceptions.TagQuotaPerResourceExceeded

  • ElastiCache.Client.exceptions.InvalidParameterValueException

  • ElastiCache.Client.exceptions.InvalidParameterCombinationException