Skip to content
v2.277.0

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).

Example ​

ts
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,
});
python
# 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
)
java
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();
csharp
// Install: dotnet add package Amazon.CDK.AWS.ElastiCache.Alpha
Vpc vpc;


var serverlessCache = new ServerlessCache(this, "ServerlessCache", new ServerlessCacheProps {
    Engine = CacheEngine.VALKEY_LATEST,
    Backup = new BackupSettings {
        // set a backup name before deleting a cache
        BackupNameBeforeDeletion = "my-final-backup-name"
    },
    Vpc = vpc
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdkelasticachealpha/v2
var vpc Vpc


serverlessCache := elasticache.NewServerlessCache(this, jsii.String("ServerlessCache"), &ServerlessCacheProps{
	Engine: elasticache.CacheEngine_VALKEY_LATEST(),
	Backup: &BackupSettings{
		// set a backup name before deleting a cache
		BackupNameBeforeDeletion: jsii.String("my-final-backup-name"),
	},
	Vpc: Vpc,
})

Properties ​

engineTypestringengine_typestrengineTypeStringEngineTypestringEngineType*string#
The engine type, for example `'valkey'`, `'redis'`, or `'memcached'`.

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

majorEngineVersionmay be undefinedstringmajor_engine_versionmay be undefinedstrmajorEngineVersionmay be undefinedStringMajorEngineVersionmay be undefinedstringMajorEngineVersionmay be undefined*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_6CacheEnginestatic#
Memcached engine, minor version 1.6, patch version is selected automatically.
MEMCACHED_LATESTCacheEnginememcached_latestCacheEngineMEMCACHED_LATESTCacheEngineMEMCACHED_LATESTCacheEngineMEMCACHED_LATESTCacheEnginestatic#
Memcached engine, latest major version available, minor version is selected automatically.
REDIS_7CacheEngineredis_7CacheEngineREDIS_7CacheEngineREDIS_7CacheEngineREDIS_7CacheEnginestatic#
Redis engine, major version 7, minor version is selected automatically.
REDIS_LATESTCacheEngineredis_latestCacheEngineREDIS_LATESTCacheEngineREDIS_LATESTCacheEngineREDIS_LATESTCacheEnginestatic#
Redis engine, latest major version available, minor version is selected automatically.
VALKEY_7CacheEnginevalkey_7CacheEngineVALKEY_7CacheEngineVALKEY_7CacheEngineVALKEY_7CacheEnginestatic#
Valkey engine, major version 7, minor version is selected automatically.
VALKEY_8CacheEnginevalkey_8CacheEngineVALKEY_8CacheEngineVALKEY_8CacheEngineVALKEY_8CacheEnginestatic#
Valkey engine, major version 8, minor version is selected automatically.
VALKEY_9CacheEnginevalkey_9CacheEngineVALKEY_9CacheEngineVALKEY_9CacheEngineVALKEY_9CacheEnginestatic#
Valkey engine, major version 9, minor version is selected automatically.
VALKEY_LATESTCacheEnginevalkey_latestCacheEngineVALKEY_LATESTCacheEngineVALKEY_LATESTCacheEngineVALKEY_LATESTCacheEnginestatic#
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').