@aws-cdk/aws-elasticache-alpha.CacheEngine

Experimental

@aws-cdk/aws-elasticache-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

CacheEngine Class

Supported cache engines together with available versions.

Named instances cover the versions currently available on ElastiCache Serverless. To target a version that is not yet represented by a named instance, use CacheEngine.of(engineType, majorEngineVersion).

Stability

Experimental

Source

lib/serverless-cache-base.ts

Example

declare const vpc: ec2.Vpc;

const serverlessCache = new elasticache.ServerlessCache(this, 'ServerlessCache', {
  engine: elasticache.CacheEngine.VALKEY_LATEST,
  backup: {
    // set a backup name before deleting a cache
    backupNameBeforeDeletion: "my-final-backup-name",
  },
  vpc,
});

Properties

engineTypestringengine_typestrengineTypeStringEngineTypestringEngineType*stringrequired#

The engine type, for example `'valkey'`, `'redis'`, or `'memcached'`.

Maps directly to the Engine property of AWS::ElastiCache::ServerlessCache.

majorEngineVersionstringmajor_engine_versionstrmajorEngineVersionStringMajorEngineVersionstringMajorEngineVersion*string#

The major engine version, for example `'9'` or `'1.6'`. Maps directly to the `MajorEngineVersion` property of `AWS::ElastiCache::ServerlessCache`. When `undefined`, the service selects the latest major version automatically.

MEMCACHED_1_6CacheEnginememcached_1_6CacheEngineMEMCACHED_1_6CacheEngineMEMCACHED_1_6CacheEngineMEMCACHED_1_6CacheEnginerequiredstatic#

Memcached engine, minor version 1.6, patch version is selected automatically.

MEMCACHED_LATESTCacheEnginememcached_latestCacheEngineMEMCACHED_LATESTCacheEngineMEMCACHED_LATESTCacheEngineMEMCACHED_LATESTCacheEnginerequiredstatic#

Memcached engine, latest major version available, minor version is selected automatically.

REDIS_7CacheEngineredis_7CacheEngineREDIS_7CacheEngineREDIS_7CacheEngineREDIS_7CacheEnginerequiredstatic#

Redis engine, major version 7, minor version is selected automatically.

REDIS_LATESTCacheEngineredis_latestCacheEngineREDIS_LATESTCacheEngineREDIS_LATESTCacheEngineREDIS_LATESTCacheEnginerequiredstatic#

Redis engine, latest major version available, minor version is selected automatically.

VALKEY_7CacheEnginevalkey_7CacheEngineVALKEY_7CacheEngineVALKEY_7CacheEngineVALKEY_7CacheEnginerequiredstatic#

Valkey engine, major version 7, minor version is selected automatically.

VALKEY_8CacheEnginevalkey_8CacheEngineVALKEY_8CacheEngineVALKEY_8CacheEngineVALKEY_8CacheEnginerequiredstatic#

Valkey engine, major version 8, minor version is selected automatically.

VALKEY_9CacheEnginevalkey_9CacheEngineVALKEY_9CacheEngineVALKEY_9CacheEngineVALKEY_9CacheEnginerequiredstatic#

Valkey engine, major version 9, minor version is selected automatically.

VALKEY_LATESTCacheEnginevalkey_latestCacheEngineVALKEY_LATESTCacheEngineVALKEY_LATESTCacheEngineVALKEY_LATESTCacheEnginerequiredstatic#

Valkey engine, latest major version available, minor version is selected automatically.

Methods

of(engineType: string, majorEngineVersion?: string): CacheEngine // chainable@staticmethod def of(engine_type: str, major_engine_version: typing.Optional[str] = None) -> CacheEnginepublic static CacheEngine of(String engineType, String majorEngineVersion)public static CacheEngine Of(string engineType, string? majorEngineVersion = null)func Of(EngineType *string, MajorEngineVersion *string) CacheEnginestatic#

Create a new `CacheEngine` with an arbitrary engine type and major version.

Use this for engine/version combinations that are not yet represented by a named static member.

2 parameters

Parameters

• engineTypeengine_typeengineTypeengineTypeEngineType — the engine type (for example, 'valkey', 'redis', or 'memcached').
• majorEngineVersionmajor_engine_versionmajorEngineVersionmajorEngineVersionMajorEngineVersion — the major engine version (for example, '9').

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this cache engine, for logging and error messages.

The format is engineType_majorEngineVersion when a major version is set, or just engineType otherwise (for example, 'valkey_8', 'memcached_1.6', 'redis').