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.

CacheUsageLimitsProperty Struct ​

Usage limits configuration for ServerlessCache.

Example ​

ts
declare const vpc: ec2.Vpc;

const serverlessCache = new elasticache.ServerlessCache(this, 'ServerlessCache', {
  engine: elasticache.CacheEngine.VALKEY_LATEST,
  vpc,
  cacheUsageLimits: {
    // cache data storage limits (GB)
    dataStorageMinimumSize: Size.gibibytes(2), // minimum: 1GB
    dataStorageMaximumSize: Size.gibibytes(3), // maximum: 5000GB
    // rate limits (ECPU/second)
    requestRateLimitMinimum: 1000, // minimum: 1000
    requestRateLimitMaximum: 10000, // maximum: 15000000
  },
});
python
# vpc: ec2.Vpc


serverless_cache = elasticache.ServerlessCache(self, "ServerlessCache",
    engine=elasticache.CacheEngine.VALKEY_LATEST,
    vpc=vpc,
    cache_usage_limits=elasticache.CacheUsageLimitsProperty(
        # cache data storage limits (GB)
        data_storage_minimum_size=Size.gibibytes(2),  # minimum: 1GB
        data_storage_maximum_size=Size.gibibytes(3),  # maximum: 5000GB
        # rate limits (ECPU/second)
        request_rate_limit_minimum=1000,  # minimum: 1000
        request_rate_limit_maximum=10000
    )
)
java
Vpc vpc;


ServerlessCache serverlessCache = ServerlessCache.Builder.create(this, "ServerlessCache")
        .engine(CacheEngine.VALKEY_LATEST)
        .vpc(vpc)
        .cacheUsageLimits(CacheUsageLimitsProperty.builder()
                // cache data storage limits (GB)
                .dataStorageMinimumSize(Size.gibibytes(2)) // minimum: 1GB
                .dataStorageMaximumSize(Size.gibibytes(3)) // maximum: 5000GB
                // rate limits (ECPU/second)
                .requestRateLimitMinimum(1000) // minimum: 1000
                .requestRateLimitMaximum(10000)
                .build())
        .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,
    Vpc = vpc,
    CacheUsageLimits = new CacheUsageLimitsProperty {
        // cache data storage limits (GB)
        DataStorageMinimumSize = Size.Gibibytes(2),  // minimum: 1GB
        DataStorageMaximumSize = Size.Gibibytes(3),  // maximum: 5000GB
        // rate limits (ECPU/second)
        RequestRateLimitMinimum = 1000,  // minimum: 1000
        RequestRateLimitMaximum = 10000
    }
});
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(),
	Vpc: Vpc,
	CacheUsageLimits: &CacheUsageLimitsProperty{
		// cache data storage limits (GB)
		DataStorageMinimumSize: awscdk.Size_Gibibytes(jsii.Number(2)),
		 // minimum: 1GB
		DataStorageMaximumSize: awscdk.Size_*Gibibytes(jsii.Number(3)),
		 // maximum: 5000GB
		// rate limits (ECPU/second)
		RequestRateLimitMinimum: jsii.Number(1000),
		 // minimum: 1000
		RequestRateLimitMaximum: jsii.Number(10000),
	},
})

Properties ​

dataStorageMaximumSizeoptionalSizedata_storage_maximum_sizeoptionalSizedataStorageMaximumSizeoptionalSizeDataStorageMaximumSizeoptionalSizeDataStorageMaximumSizeoptionalSize #
Maximum data storage size (5000 GB).

Default: No maximum limit

dataStorageMinimumSizeoptionalSizedata_storage_minimum_sizeoptionalSizedataStorageMinimumSizeoptionalSizeDataStorageMinimumSizeoptionalSizeDataStorageMinimumSizeoptionalSize #
Minimum data storage size (1 GB).

Default: No minimum limit

requestRateLimitMaximumoptionalnumberrequest_rate_limit_maximumoptionalint | floatrequestRateLimitMaximumoptionalNumberRequestRateLimitMaximumoptionaldoubleRequestRateLimitMaximumoptional*float64 #
Maximum request rate limit (15000000 ECPUs per second).

Default: No maximum limit

requestRateLimitMinimumoptionalnumberrequest_rate_limit_minimumoptionalint | floatrequestRateLimitMinimumoptionalNumberRequestRateLimitMinimumoptionaldoubleRequestRateLimitMinimumoptional*float64 #
Minimum request rate limit (1000 ECPUs per second).

Default: No minimum limit