ElastiCache / Client / modify_serverless_cache

modify_serverless_cache#

ElastiCache.Client.modify_serverless_cache(**kwargs)#

This API modifies the attributes of a serverless cache.

Request Syntax

response = client.modify_serverless_cache(
    ServerlessCacheName='string',
    Description='string',
    CacheUsageLimits={
        'DataStorage': {
            'Maximum': 123,
            'Unit': 'GB'
        },
        'ECPUPerSecond': {
            'Maximum': 123
        }
    },
    RemoveUserGroup=True|False,
    UserGroupId='string',
    SecurityGroupIds=[
        'string',
    ],
    SnapshotRetentionLimit=123,
    DailySnapshotTime='string'
)

Parameters:

ServerlessCacheName (string) –
[REQUIRED]

User-provided identifier for the serverless cache to be modified.
Description (string) – User provided description for the serverless cache. Default = NULL, i.e. the existing description is not removed/modified. The description has a maximum length of 255 characters.
CacheUsageLimits (dict) –
Modify the cache usage limit for the serverless cache.
- DataStorage (dict) –
  
  The maximum data storage limit in the cache, expressed in Gigabytes.
  - Maximum (integer) – [REQUIRED]
    
    The upper limit for data storage the cache is set to use.
  - Unit (string) – [REQUIRED]
    
    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) – [REQUIRED]
    
    The configuration for the maximum number of ECPUs the cache can consume per second.
RemoveUserGroup (boolean) – The identifier of the UserGroup to be removed from association with the Redis serverless cache. Available for Redis only. Default is NULL.
UserGroupId (string) – The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL - the existing UserGroup is not removed.
SecurityGroupIds (list) –
The new list of VPC security groups to be associated with the serverless cache. Populating this list means the current VPC security groups will be removed. This security group is used to authorize traffic access for the VPC end-point (private-link). Default = NULL - the existing list of VPC security groups is not removed.
- (string) –
SnapshotRetentionLimit (integer) – The number of days for which Elasticache retains automatic snapshots before deleting them. Available for Redis only. Default = NULL, i.e. the existing snapshot-retention-limit will not be removed or modified. The maximum value allowed is 35 days.
DailySnapshotTime (string) – The daily time during which Elasticache begins taking a daily snapshot of the serverless cache. Available for Redis only. The default is NULL, i.e. the existing snapshot time configured for the cluster is not removed.

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) –
  
  The response for the attempt to modify the serverless cache.
  - 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.InvalidParameterValueException
ElastiCache.Client.exceptions.InvalidParameterCombinationException
ElastiCache.Client.exceptions.InvalidCredentialsException
ElastiCache.Client.exceptions.InvalidUserGroupStateFault
ElastiCache.Client.exceptions.UserGroupNotFoundFault
ElastiCache.Client.exceptions.ServiceLinkedRoleNotFoundFault