Experimental
@aws-cdk/aws-elasticache-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
ServerlessCache L2 construct
A serverless ElastiCache cache.
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,
})
Initializer
ts
new ServerlessCache(scope: Construct, id: string, props: ServerlessCacheProps)
python
ServerlessCache(scope: Construct, id: str, props: ServerlessCacheProps)
java
new ServerlessCache(Construct scope, String id, ServerlessCacheProps props)
csharp
new ServerlessCache(Construct scope, string id, ServerlessCacheProps props)
go
NewServerlessCache(Scope Construct, Id *string, Props ServerlessCacheProps)
Construct Props
backupBackupSettingsbackupBackupSettingsbackupBackupSettingsBackupBackupSettingsBackupBackupSettings= No backups configured#Backup configuration.
cacheUsageLimitsCacheUsageLimitsPropertycache_usage_limitsCacheUsageLimitsPropertycacheUsageLimitsCacheUsageLimitsPropertyCacheUsageLimitsCacheUsageLimitsPropertyCacheUsageLimitsCacheUsageLimitsProperty= No usage limits#Usage limits for the cache.
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= No description#A description for the cache.
engineCacheEngineengineCacheEngineengineCacheEngineEngineCacheEngineEngineCacheEngine= when not provided, the default e…#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
Default: when not provided, the default engine would be Valkey, latest version available (VALKEY_DEFAULT)
KMS key for encryption.
default
Default: Service managed encryption (AWS owned KMS key)
securityGroupsISecurityGroup[]security_groupstyping.List[ISecurityGroup]securityGroupsList<ISecurityGroup>SecurityGroupsISecurityGroup[]SecurityGroups*[]ISecurityGroup= A new security group is created#Security groups for the cache.
serverlessCacheNamestringserverless_cache_namestrserverlessCacheNameStringServerlessCacheNamestringServerlessCacheName*string= automatically generated name by …#Name for the serverless cache.
default
Default: automatically generated name by Resource
userGroupIUserGroupuser_groupIUserGroupuserGroupIUserGroupUserGroupIUserGroupUserGroupIUserGroup= No user group#User group for access control.
vpcSubnetsSubnetSelectionvpc_subnetsSubnetSelectionvpcSubnetsSubnetSelectionVpcSubnetsSubnetSelectionVpcSubnetsSubnetSelection= Private subnets with egress#Which subnets to place the cache in.
Properties
backupArnsToRestorestring[]backup_arns_to_restoretyping.List[str]backupArnsToRestoreList<String>BackupArnsToRestorestring[]BackupArnsToRestore*[]*string#The ARNs of backups restored in the cache.
connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnectionsrequired#Access to network connections.
The cache engine used by this cache.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#The environment this resource belongs to.
notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
grantsServerlessCacheGrantsgrantsServerlessCacheGrantsgrantsServerlessCacheGrantsGrantsServerlessCacheGrantsGrantsServerlessCacheGrantsrequired#Collection of grant methods for this cache.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Uniquely identifies this class.
securityGroupsISecurityGroup[]security_groupstyping.List[ISecurityGroup]securityGroupsList<ISecurityGroup>SecurityGroupsISecurityGroup[]SecurityGroups*[]ISecurityGroup#The security groups associated with this cache.
serverlessCacheArnstringserverless_cache_arnstrserverlessCacheArnStringServerlessCacheArnstringServerlessCacheArn*stringrequired#The ARN of the serverless cache.
serverlessCacheEndpointAddressstringserverless_cache_endpoint_addressstrserverlessCacheEndpointAddressStringServerlessCacheEndpointAddressstringServerlessCacheEndpointAddress*stringrequired#The endpoint address of the serverless cache.
serverlessCacheEndpointPortstringserverless_cache_endpoint_portstrserverlessCacheEndpointPortStringServerlessCacheEndpointPortstringServerlessCacheEndpointPort*stringrequired#The endpoint port of the serverless cache.
serverlessCacheNamestringserverless_cache_namestrserverlessCacheNameStringServerlessCacheNamestringServerlessCacheName*stringrequired#The name of the serverless cache.
serverlessCacheReaderEndpointAddressstringserverless_cache_reader_endpoint_addressstrserverlessCacheReaderEndpointAddressStringServerlessCacheReaderEndpointAddressstringServerlessCacheReaderEndpointAddress*stringrequired#The reader endpoint address of the serverless cache.
serverlessCacheReaderEndpointPortstringserverless_cache_reader_endpoint_portstrserverlessCacheReaderEndpointPortStringServerlessCacheReaderEndpointPortstringServerlessCacheReaderEndpointPort*stringrequired#The reader endpoint port of the serverless cache.
serverlessCacheRefServerlessCacheReferenceserverless_cache_refServerlessCacheReferenceserverlessCacheRefServerlessCacheReferenceServerlessCacheRefServerlessCacheReferenceServerlessCacheRefServerlessCacheReferencerequired#A reference to a ServerlessCache resource.
serverlessCacheStatusstringserverless_cache_statusstrserverlessCacheStatusStringServerlessCacheStatusstringServerlessCacheStatus*stringrequired#The current status of the serverless cache Can be 'CREATING', 'AVAILABLE', 'DELETING', 'CREATE-FAILED', 'MODIFYING'.
The stack in which this resource is defined.
The subnets this cache is deployed in.
The user group associated with this cache.
Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Override the cross-stack reference strength for this resource.
notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#Apply the given removal policy to this resource.
notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
fromServerlessCacheArn(scope: Construct, id: string, serverlessCacheArn: string): IServerlessCache@staticmethod def from_serverless_cache_arn(scope: Construct, id: str, serverless_cache_arn: str) -> IServerlessCachepublic static IServerlessCache fromServerlessCacheArn(Construct scope, String id, String serverlessCacheArn)public static IServerlessCache FromServerlessCacheArn(Construct scope, string id, string serverlessCacheArn)func FromServerlessCacheArn(Scope Construct, Id *string, ServerlessCacheArn *string) IServerlessCachestatic#Import an existing serverless cache by ARN.
3 parameters
Parameters
scopescopescopescopeScope— The parent creating construct (usuallythis).ididididId— The construct's name.serverlessCacheArnserverless_cache_arnserverlessCacheArnserverlessCacheArnServerlessCacheArn— The ARN of the existing serverless cache.
fromServerlessCacheAttributes(scope: Construct, id: string, attrs: ServerlessCacheAttributes): IServerlessCache@staticmethod def from_serverless_cache_attributes(scope: Construct, id: str, attrs: ServerlessCacheAttributes) -> IServerlessCachepublic static IServerlessCache fromServerlessCacheAttributes(Construct scope, String id, ServerlessCacheAttributes attrs)public static IServerlessCache FromServerlessCacheAttributes(Construct scope, string id, ServerlessCacheAttributes attrs)func FromServerlessCacheAttributes(Scope Construct, Id *string, Attrs ServerlessCacheAttributes) IServerlessCachestatic#Import an existing serverless cache using attributes.
3 parameters
Parameters
scopescopescopescopeScope— The parent creating construct (usuallythis).ididididId— The construct's name.attrsattrsattrsattrsAttrs— AServerlessCacheAttributesobject.
fromServerlessCacheName(scope: Construct, id: string, serverlessCacheName: string): IServerlessCache@staticmethod def from_serverless_cache_name(scope: Construct, id: str, serverless_cache_name: str) -> IServerlessCachepublic static IServerlessCache fromServerlessCacheName(Construct scope, String id, String serverlessCacheName)public static IServerlessCache FromServerlessCacheName(Construct scope, string id, string serverlessCacheName)func FromServerlessCacheName(Scope Construct, Id *string, ServerlessCacheName *string) IServerlessCachestatic#Import an existing serverless cache by name.
3 parameters
Parameters
scopescopescopescopeScope— The parent creating construct (usuallythis).ididididId— The construct's name.serverlessCacheNameserverless_cache_nameserverlessCacheNameserverlessCacheNameServerlessCacheName— The name of the existing serverless cache.
grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#Grant the given identity custom permissions [disable-awslint:no-grants].
2 parameters
Parameters
granteegranteegranteegranteeGrantee— The principal to grant permissions to.actionsactionsactionsactionsActions— The actions to grant.
grantConnect(grantee: IGrantable): Grantdef grant_connect(self, grantee: IGrantable) -> Grantpublic Grant grantConnect(IGrantable grantee)public Grant GrantConnect(IGrantable grantee)func GrantConnect(Grantee IGrantable) Grant#Grant connect permissions to the cache [disable-awslint:no-grants].
1 parameter
Parameters
granteegranteegranteegranteeGrantee— The principal to grant permissions to.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#Check whether the given construct is a Resource.
isServerlessCache(x: any): boolean@staticmethod def is_serverless_cache(x: Any) -> boolpublic static Boolean isServerlessCache(Object x)public static bool IsServerlessCache(object x)func IsServerlessCache(X interface{}) *boolstatic#Return whether the given object is a `ServerlessCache`.
metric(metricName: string, props?: MetricOptions): Metricdef metric(self, metric_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, MetricOptions props)public Metric Metric(string metricName, MetricOptions? props = null)func Metric(MetricName *string, Props MetricOptions) Metric#Return the given named metric for this cache.
2 parameters
Parameters
metricNamemetric_namemetricNamemetricNameMetricName— The name of the metric.propspropspropspropsProps— Additional properties which will be merged with the default metric.
metricActiveConnections(props?: MetricOptions): Metricdef metric_active_connections(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricActiveConnections(MetricOptions props)public Metric MetricActiveConnections(MetricOptions? props = null)func MetricActiveConnections(Props MetricOptions) Metric#Metric for active connections.
1 parameter
Parameters
propspropspropspropsProps— Additional properties which will be merged with the default metric.
metricCacheHitCount(props?: MetricOptions): Metricdef metric_cache_hit_count(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricCacheHitCount(MetricOptions props)public Metric MetricCacheHitCount(MetricOptions? props = null)func MetricCacheHitCount(Props MetricOptions) Metric#Metric for cache hit count.
1 parameter
Parameters
propspropspropspropsProps— Additional properties which will be merged with the default metric.
metricCacheHitRate(props?: MetricOptions): Metricdef metric_cache_hit_rate(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricCacheHitRate(MetricOptions props)public Metric MetricCacheHitRate(MetricOptions? props = null)func MetricCacheHitRate(Props MetricOptions) Metric#Metric for cache hit rate.
1 parameter
Parameters
propspropspropspropsProps— Additional properties which will be merged with the default metric.
metricCacheMissCount(props?: MetricOptions): Metricdef metric_cache_miss_count(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricCacheMissCount(MetricOptions props)public Metric MetricCacheMissCount(MetricOptions? props = null)func MetricCacheMissCount(Props MetricOptions) Metric#Metric for cache miss count.
1 parameter
Parameters
propspropspropspropsProps— Additional properties which will be merged with the default metric.
metricDataStored(props?: MetricOptions): Metricdef metric_data_stored(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricDataStored(MetricOptions props)public Metric MetricDataStored(MetricOptions? props = null)func MetricDataStored(Props MetricOptions) Metric#Metric for data stored in the cache.
1 parameter
Parameters
propspropspropspropsProps— Additional properties which will be merged with the default metric.
metricNetworkBytesIn(props?: MetricOptions): Metricdef metric_network_bytes_in(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricNetworkBytesIn(MetricOptions props)public Metric MetricNetworkBytesIn(MetricOptions? props = null)func MetricNetworkBytesIn(Props MetricOptions) Metric#Metric for network bytes in.
1 parameter
Parameters
propspropspropspropsProps— Additional properties which will be merged with the default metric.
metricNetworkBytesOut(props?: MetricOptions): Metricdef metric_network_bytes_out(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricNetworkBytesOut(MetricOptions props)public Metric MetricNetworkBytesOut(MetricOptions? props = null)func MetricNetworkBytesOut(Props MetricOptions) Metric#Metric for network bytes out.
1 parameter
Parameters
propspropspropspropsProps— Additional properties which will be merged with the default metric.
metricProcessingUnitsConsumed(props?: MetricOptions): Metricdef metric_processing_units_consumed(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricProcessingUnitsConsumed(MetricOptions props)public Metric MetricProcessingUnitsConsumed(MetricOptions? props = null)func MetricProcessingUnitsConsumed(Props MetricOptions) Metric#Metric for ECPUs consumed.
1 parameter
Parameters
propspropspropspropsProps— Additional properties which will be merged with the default metric.
metricReadRequestLatency(props?: MetricOptions): Metricdef metric_read_request_latency(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricReadRequestLatency(MetricOptions props)public Metric MetricReadRequestLatency(MetricOptions? props = null)func MetricReadRequestLatency(Props MetricOptions) Metric#Metric for read request latency.
1 parameter
Parameters
propspropspropspropsProps— Additional properties which will be merged with the default metric.
metricWriteRequestLatency(props?: MetricOptions): Metricdef metric_write_request_latency(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricWriteRequestLatency(MetricOptions props)public Metric MetricWriteRequestLatency(MetricOptions? props = null)func MetricWriteRequestLatency(Props MetricOptions) Metric#Metric for write request latency.
1 parameter
Parameters
propspropspropspropsProps— Additional properties which will be merged with the default metric.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.