Experimental
@aws-cdk/aws-elasticache-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
ServerlessCacheProps Struct
Properties for defining a ServerlessCache.
| Stability | Experimental |
|---|---|
| Source | lib/serverless-cache.ts |
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
backupoptionalBackupSettingsbackupoptionalBackupSettingsbackupoptionalBackupSettingsBackupoptionalBackupSettingsBackupoptionalBackupSettings #Backup configuration.
Default: No backups configured
cacheUsageLimitsoptionalCacheUsageLimitsPropertycache_usage_limitsoptionalCacheUsageLimitsPropertycacheUsageLimitsoptionalCacheUsageLimitsPropertyCacheUsageLimitsoptionalCacheUsageLimitsPropertyCacheUsageLimitsoptionalCacheUsageLimitsProperty #Usage limits for the cache.
Default: No usage limits
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #A description for the cache.
Default: No description
engineoptionalCacheEngineengineoptionalCacheEngineengineoptionalCacheEngineEngineoptionalCacheEngineEngineoptionalCacheEngine #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 for encryption.
Default: Service managed encryption (AWS owned KMS key)
securityGroupsoptionalISecurityGroup[]security_groupsoptionaltyping.List[ISecurityGroup]securityGroupsoptionalList<ISecurityGroup>SecurityGroupsoptionalISecurityGroup[]SecurityGroupsoptional*[]ISecurityGroup #Security groups for the cache.
Default: A new security group is created
serverlessCacheNameoptionalstringserverless_cache_nameoptionalstrserverlessCacheNameoptionalStringServerlessCacheNameoptionalstringServerlessCacheNameoptional*string #Name for the serverless cache.
Default: automatically generated name by Resource
userGroupoptionalIUserGroupuser_groupoptionalIUserGroupuserGroupoptionalIUserGroupUserGroupoptionalIUserGroupUserGroupoptionalIUserGroup #User group for access control.
Default: No user group
vpcSubnetsoptionalSubnetSelectionvpc_subnetsoptionalSubnetSelectionvpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelection #Which subnets to place the cache in.
Default: Private subnets with egress