Skip to content

ModifyServerlessCacheRequest

Source code in docs_src/capo_elasticache/types/modify_serverless_cache_request.py
class ModifyServerlessCacheRequest(TypedDict, closed=True):
    serverless_cache_name: NotRequired["capo_elasticache.types.string.String"]
    """<p>User-provided identifier for the serverless cache to be modified.</p>"""
    description: NotRequired["capo_elasticache.types.string.String"]
    """<p>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.</p>"""
    cache_usage_limits: NotRequired[
        "capo_elasticache.types.cache_usage_limits.CacheUsageLimits"
    ]
    """<p>Modify the cache usage limit for the serverless cache.</p>"""
    remove_user_group: NotRequired[
        "capo_elasticache.types.boolean_optional.BooleanOptional"
    ]
    """<p>The identifier of the UserGroup to be removed from association with the Valkey and Redis OSS serverless cache. Available for Valkey and Redis OSS only. Default is NULL.</p>"""
    user_group_id: NotRequired["capo_elasticache.types.string.String"]
    """<p>The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL - the existing UserGroup is not removed.</p>"""
    security_group_ids: NotRequired[
        "capo_elasticache.types.security_group_ids_list.SecurityGroupIdsList"
    ]
    """<p>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.</p>"""
    snapshot_retention_limit: NotRequired[
        "capo_elasticache.types.integer_optional.IntegerOptional"
    ]
    """<p>The number of days for which Elasticache retains automatic snapshots before deleting them. Available for Valkey, Redis OSS and Serverless Memcached only. Default = NULL, i.e. the existing snapshot-retention-limit will not be removed or modified. The maximum value allowed is 35 days.</p>"""
    daily_snapshot_time: NotRequired["capo_elasticache.types.string.String"]
    """<p>The daily time during which Elasticache begins taking a daily snapshot of the serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only. The default is NULL, i.e. the existing snapshot time configured for the cluster is not removed.</p>"""
    engine: NotRequired["capo_elasticache.types.string.String"]
    """<p>Modifies the engine listed in a serverless cache request. The options are valkey, memcached or redis.</p>"""
    major_engine_version: NotRequired["capo_elasticache.types.string.String"]
    """<p>Modifies the engine vesion listed in a serverless cache request. </p>"""

cache_usage_limits instance-attribute

cache_usage_limits: NotRequired[CacheUsageLimits]

Modify the cache usage limit for the serverless cache.

daily_snapshot_time instance-attribute

daily_snapshot_time: NotRequired[String]

The daily time during which Elasticache begins taking a daily snapshot of the serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only. The default is NULL, i.e. the existing snapshot time configured for the cluster is not removed.

description instance-attribute

description: NotRequired[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.

engine instance-attribute

engine: NotRequired[String]

Modifies the engine listed in a serverless cache request. The options are valkey, memcached or redis.

major_engine_version instance-attribute

major_engine_version: NotRequired[String]

Modifies the engine vesion listed in a serverless cache request.

remove_user_group instance-attribute

remove_user_group: NotRequired[BooleanOptional]

The identifier of the UserGroup to be removed from association with the Valkey and Redis OSS serverless cache. Available for Valkey and Redis OSS only. Default is NULL.

security_group_ids instance-attribute

security_group_ids: NotRequired[SecurityGroupIdsList]

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.

serverless_cache_name instance-attribute

serverless_cache_name: NotRequired[String]

User-provided identifier for the serverless cache to be modified.

snapshot_retention_limit instance-attribute

snapshot_retention_limit: NotRequired[IntegerOptional]

The number of days for which Elasticache retains automatic snapshots before deleting them. Available for Valkey, Redis OSS and Serverless Memcached only. Default = NULL, i.e. the existing snapshot-retention-limit will not be removed or modified. The maximum value allowed is 35 days.

user_group_id instance-attribute

user_group_id: NotRequired[String]

The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL - the existing UserGroup is not removed.