CfnServerlessCacheProps

class aws_cdk.aws_elasticache.CfnServerlessCacheProps(*, engine, serverless_cache_name, cache_usage_limits=None, daily_snapshot_time=None, description=None, endpoint=None, final_snapshot_name=None, kms_key_id=None, major_engine_version=None, reader_endpoint=None, security_group_ids=None, snapshot_arns_to_restore=None, snapshot_retention_limit=None, subnet_ids=None, tags=None, user_group_id=None)

Bases: object

Properties for defining a CfnServerlessCache.

Parameters:

engine (str) – The engine the serverless cache is compatible with.
serverless_cache_name (str) – The unique identifier of the serverless cache.
cache_usage_limits (Union[IResolvable, CacheUsageLimitsProperty, Dict[str, Any], None]) – The cache usage limit for the serverless cache.
daily_snapshot_time (Optional[str]) – 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 (Optional[str]) – A description of the serverless cache.
endpoint (Union[IResolvable, EndpointProperty, Dict[str, Any], None]) – Represents the information required for client programs to connect to a cache node. This value is read-only.
final_snapshot_name (Optional[str]) – The name of the final snapshot taken of a cache before the cache is deleted.
kms_key_id (Optional[str]) – The ID of the AWS Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.
major_engine_version (Optional[str]) – The version number of the engine the serverless cache is compatible with.
reader_endpoint (Union[IResolvable, EndpointProperty, Dict[str, Any], None]) – Represents the information required for client programs to connect to a cache node. This value is read-only.
security_group_ids (Optional[Sequence[str]]) – The IDs of the EC2 security groups associated with the serverless cache.
snapshot_arns_to_restore (Optional[Sequence[str]]) – The ARN of the snapshot from which to restore data into the new cache.
snapshot_retention_limit (Union[int, float, None]) – The current setting for the number of serverless cache snapshots the system will retain. Available for Valkey, Redis OSS and Serverless Memcached only.
subnet_ids (Optional[Sequence[str]]) – 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.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of tags to be added to this resource.
user_group_id (Optional[str]) – The identifier of the user group associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_elasticache as elasticache

cfn_serverless_cache_props = elasticache.CfnServerlessCacheProps(
    engine="engine",
    serverless_cache_name="serverlessCacheName",

    # the properties below are optional
    cache_usage_limits=elasticache.CfnServerlessCache.CacheUsageLimitsProperty(
        data_storage=elasticache.CfnServerlessCache.DataStorageProperty(
            unit="unit",

            # the properties below are optional
            maximum=123,
            minimum=123
        ),
        ecpu_per_second=elasticache.CfnServerlessCache.ECPUPerSecondProperty(
            maximum=123,
            minimum=123
        )
    ),
    daily_snapshot_time="dailySnapshotTime",
    description="description",
    endpoint=elasticache.CfnServerlessCache.EndpointProperty(
        address="address",
        port="port"
    ),
    final_snapshot_name="finalSnapshotName",
    kms_key_id="kmsKeyId",
    major_engine_version="majorEngineVersion",
    reader_endpoint=elasticache.CfnServerlessCache.EndpointProperty(
        address="address",
        port="port"
    ),
    security_group_ids=["securityGroupIds"],
    snapshot_arns_to_restore=["snapshotArnsToRestore"],
    snapshot_retention_limit=123,
    subnet_ids=["subnetIds"],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    user_group_id="userGroupId"
)

Attributes

cache_usage_limits

The cache usage limit for the serverless cache.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-cacheusagelimits

daily_snapshot_time

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.