ServerlessCacheProps

class aws_cdk.aws_elasticache_alpha.ServerlessCacheProps(*, vpc, backup=None, cache_usage_limits=None, description=None, engine=None, kms_key=None, security_groups=None, serverless_cache_name=None, user_group=None, vpc_subnets=None)

Bases: object

(experimental) Properties for defining a ServerlessCache.

Parameters:

  • vpc (IVpc) – (experimental) The VPC to place the cache in.

  • backup (Union[BackupSettings, Dict[str, Any], None]) – (experimental) Backup configuration. Default: - No backups configured

  • cache_usage_limits (Union[CacheUsageLimitsProperty, Dict[str, Any], None]) – (experimental) Usage limits for the cache. Default: - No usage limits

  • description (Optional[str]) – (experimental) A description for the cache. Default: - No description

  • engine (Optional[CacheEngine]) – (experimental) The cache engine combined with the version Enum options: VALKEY_DEFAULT, VALKEY_7, VALKEY_8, REDIS_DEFAULT, MEMCACHED_DEFAULT The default options bring the latest versions available. Default: when not provided, the default engine would be Valkey, latest version available (VALKEY_DEFAULT)

  • kms_key (Optional[IKey]) – (experimental) KMS key for encryption. Default: - Service managed encryption (AWS owned KMS key)

  • security_groups (Optional[Sequence[ISecurityGroup]]) – (experimental) Security groups for the cache. Default: - A new security group is created

  • serverless_cache_name (Optional[str]) – (experimental) Name for the serverless cache. Default: automatically generated name by Resource

  • user_group (Optional[IUserGroup]) – (experimental) User group for access control. Default: - No user group

  • vpc_subnets (Union[SubnetSelection, Dict[str, Any], None]) – (experimental) Which subnets to place the cache in. Default: - Private subnets with egress

Stability:

experimental

ExampleMetadata:

infused

Example:

# vpc: ec2.Vpc


serverless_cache = elasticache.ServerlessCache(self, "ServerlessCache",
    engine=elasticache.CacheEngine.VALKEY_LATEST,
    backup=elasticache.BackupSettings(
        # set a backup name before deleting a cache
        backup_name_before_deletion="my-final-backup-name"
    ),
    vpc=vpc
)

Attributes

backup

(experimental) Backup configuration.

Default:

  • No backups configured

Stability:

experimental

cache_usage_limits

(experimental) Usage limits for the cache.

Default:

  • No usage limits

Stability:

experimental

description

(experimental) A description for the cache.

Default:

  • No description

Stability:

experimental

engine

VALKEY_DEFAULT, VALKEY_7, VALKEY_8, REDIS_DEFAULT, MEMCACHED_DEFAULT The default options bring the latest versions available.

Default:

when not provided, the default engine would be Valkey, latest version available (VALKEY_DEFAULT)

Stability:

experimental

Type:

(experimental) The cache engine combined with the version Enum options

kms_key

(experimental) KMS key for encryption.

Default:

  • Service managed encryption (AWS owned KMS key)

Stability:

experimental

security_groups

(experimental) Security groups for the cache.

Default:

  • A new security group is created

Stability:

experimental

serverless_cache_name

(experimental) Name for the serverless cache.

Default:

automatically generated name by Resource

Stability:

experimental

user_group

(experimental) User group for access control.

Default:

  • No user group

Stability:

experimental

vpc

(experimental) The VPC to place the cache in.

Stability:

experimental

vpc_subnets

(experimental) Which subnets to place the cache in.

Default:

  • Private subnets with egress

Stability:

experimental