Skip to content

ServerlessCache

Source code in docs_src/capo_elasticache/types/serverless_cache.py
class ServerlessCache(TypedDict, closed=True):
    serverless_cache_name: NotRequired["capo_elasticache.types.string.String"]
    """<p>The unique identifier of the serverless cache.</p>"""
    description: NotRequired["capo_elasticache.types.string.String"]
    """<p>A description of the serverless cache.</p>"""
    create_time: NotRequired["capo_elasticache.types.t_stamp.TStamp"]
    """<p>When the serverless cache was created. </p>"""
    status: NotRequired["capo_elasticache.types.string.String"]
    """<p>The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.</p>"""
    engine: NotRequired["capo_elasticache.types.string.String"]
    """<p>The engine the serverless cache is compatible with.</p>"""
    major_engine_version: NotRequired["capo_elasticache.types.string.String"]
    """<p>The version number of the engine the serverless cache is compatible with.</p>"""
    full_engine_version: NotRequired["capo_elasticache.types.string.String"]
    """<p>The name and version number of the engine the serverless cache is compatible with.</p>"""
    cache_usage_limits: NotRequired[
        "capo_elasticache.types.cache_usage_limits.CacheUsageLimits"
    ]
    """<p>The cache usage limit for the serverless cache.</p>"""
    kms_key_id: NotRequired["capo_elasticache.types.string.String"]
    """<p>The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.</p>"""
    storage_encryption_type: NotRequired[
        "capo_elasticache.types.storage_encryption_type.StorageEncryptionType"
    ]
    """<p>Indicates the type of encryption for data stored at rest in the serverless cache. Serverless caches are always encrypted at rest. The value is <code>sse-elasticache</code> if an ElastiCache service-managed key is used, or <code>sse-kms</code> if a customer-managed KMS key is used.</p>"""
    security_group_ids: NotRequired[
        "capo_elasticache.types.security_group_ids_list.SecurityGroupIdsList"
    ]
    """<p>The IDs of the EC2 security groups associated with the serverless cache.</p>"""
    endpoint: NotRequired["capo_elasticache.types.endpoint.Endpoint"]
    reader_endpoint: NotRequired["capo_elasticache.types.endpoint.Endpoint"]
    arn: NotRequired["capo_elasticache.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the serverless cache.</p>"""
    user_group_id: NotRequired["capo_elasticache.types.string.String"]
    """<p>The identifier of the user group associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.</p>"""
    subnet_ids: NotRequired["capo_elasticache.types.subnet_ids_list.SubnetIdsList"]
    """<p>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.</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. The maximum value allowed is 35 days.</p>"""
    daily_snapshot_time: NotRequired["capo_elasticache.types.string.String"]
    """<p>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 Valkey, Redis OSS and Serverless Memcached only.</p>"""
    network_type: NotRequired["capo_elasticache.types.network_type.NetworkType"]
    """<p>The type of IP address protocol used by the serverless cache. Must be either <code>ipv4</code> | <code>ipv6</code> | <code>dual_stack</code>. <code>ipv6</code> is only supported with IPv6-only subnets. If not specified, defaults to <code>ipv4</code>, unless all provided subnets are IPv6-only, in which case it defaults to <code>ipv6</code>.</p>"""
    connection_type: NotRequired[
        "capo_elasticache.types.connection_type.ConnectionType"
    ]
    """<p>The connection type for the serverless cache. Must be either <code>vpc</code> | <code>public</code>. If not specified, defaults to <code>vpc</code>.</p>"""

arn instance-attribute

arn: NotRequired[String]

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

cache_usage_limits instance-attribute

cache_usage_limits: NotRequired[CacheUsageLimits]

The cache usage limit for the serverless cache.

connection_type instance-attribute

connection_type: NotRequired[ConnectionType]

The connection type for the serverless cache. Must be either vpc | public. If not specified, defaults to vpc.

create_time instance-attribute

create_time: NotRequired[TStamp]

When the serverless cache was created.

daily_snapshot_time instance-attribute

daily_snapshot_time: NotRequired[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 Valkey, Redis OSS and Serverless Memcached only.

description instance-attribute

description: NotRequired[String]

A description of the serverless cache.

endpoint instance-attribute

endpoint: NotRequired[Endpoint]

engine instance-attribute

engine: NotRequired[String]

The engine the serverless cache is compatible with.

full_engine_version instance-attribute

full_engine_version: NotRequired[String]

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

kms_key_id instance-attribute

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

major_engine_version instance-attribute

major_engine_version: NotRequired[String]

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

network_type instance-attribute

network_type: NotRequired[NetworkType]

The type of IP address protocol used by the serverless cache. Must be either ipv4 | ipv6 | dual_stack. ipv6 is only supported with IPv6-only subnets. If not specified, defaults to ipv4, unless all provided subnets are IPv6-only, in which case it defaults to ipv6.

reader_endpoint instance-attribute

reader_endpoint: NotRequired[Endpoint]

security_group_ids instance-attribute

security_group_ids: NotRequired[SecurityGroupIdsList]

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

serverless_cache_name instance-attribute

serverless_cache_name: NotRequired[String]

The unique identifier of the serverless cache.

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. The maximum value allowed is 35 days.

status instance-attribute

status: NotRequired[String]

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

storage_encryption_type instance-attribute

storage_encryption_type: NotRequired[StorageEncryptionType]

Indicates the type of encryption for data stored at rest in the serverless cache. Serverless caches are always encrypted at rest. The value is sse-elasticache if an ElastiCache service-managed key is used, or sse-kms if a customer-managed KMS key is used.

subnet_ids instance-attribute

subnet_ids: NotRequired[SubnetIdsList]

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.

user_group_id instance-attribute

user_group_id: NotRequired[String]

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