Package software.amazon.awscdk.services.elasticache.alpha

Interface ServerlessCacheProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ServerlessCacheProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-10-01T17:47:05.837Z") @Stability(Experimental) public interface ServerlessCacheProps extends software.amazon.jsii.JsiiSerializable
(experimental) Properties for defining a ServerlessCache.

Example: 

 Vpc vpc;
 ServerlessCache serverlessCache = ServerlessCache.Builder.create(this, "ServerlessCache")
         .engine(CacheEngine.VALKEY_LATEST)
         .backup(BackupSettings.builder()
                 // set a backup name before deleting a cache
                 .backupNameBeforeDeletion("my-final-backup-name")
                 .build())
         .vpc(vpc)
         .build();

  • Method Details

    • getVpc

      @Stability(Experimental) @NotNull IVpc getVpc()
      (experimental) The VPC to place the cache in.

    • getBackup

      @Stability(Experimental) @Nullable default BackupSettings getBackup()
      (experimental) Backup configuration.

      Default: - No backups configured

    • getCacheUsageLimits

      @Stability(Experimental) @Nullable default CacheUsageLimitsProperty getCacheUsageLimits()
      (experimental) Usage limits for the cache.

      Default: - No usage limits

    • getDescription

      @Stability(Experimental) @Nullable default String getDescription()
      (experimental) A description for the cache.

      Default: - No description

    • getEngine

      @Stability(Experimental) @Nullable default CacheEngine getEngine()
      (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)

    • getKmsKey

      @Stability(Experimental) @Nullable default IKey getKmsKey()
      (experimental) KMS key for encryption.

      Default: - Service managed encryption (AWS owned KMS key)

    • getSecurityGroups

      @Stability(Experimental) @Nullable default List<ISecurityGroup> getSecurityGroups()
      (experimental) Security groups for the cache.

      Default: - A new security group is created

    • getServerlessCacheName

      @Stability(Experimental) @Nullable default String getServerlessCacheName()
      (experimental) Name for the serverless cache.

      Default: automatically generated name by Resource

    • getUserGroup

      @Stability(Experimental) @Nullable default IUserGroup getUserGroup()
      (experimental) User group for access control.

      Default: - No user group

    • getVpcSubnets

      @Stability(Experimental) @Nullable default SubnetSelection getVpcSubnets()
      (experimental) Which subnets to place the cache in.

      Default: - Private subnets with egress

    • builder

      @Stability(Experimental) static ServerlessCacheProps.Builder builder()
      Returns:
      a ServerlessCacheProps.Builder of ServerlessCacheProps