Interface CfnServerlessCacheProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnServerlessCacheProps.Jsii$Proxy
CfnServerlessCache.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.elasticache.*;
CfnServerlessCacheProps cfnServerlessCacheProps = CfnServerlessCacheProps.builder()
.engine("engine")
.serverlessCacheName("serverlessCacheName")
// the properties below are optional
.cacheUsageLimits(CacheUsageLimitsProperty.builder()
.dataStorage(DataStorageProperty.builder()
.unit("unit")
// the properties below are optional
.maximum(123)
.minimum(123)
.build())
.ecpuPerSecond(ECPUPerSecondProperty.builder()
.maximum(123)
.minimum(123)
.build())
.build())
.dailySnapshotTime("dailySnapshotTime")
.description("description")
.endpoint(EndpointProperty.builder()
.address("address")
.port("port")
.build())
.finalSnapshotName("finalSnapshotName")
.kmsKeyId("kmsKeyId")
.majorEngineVersion("majorEngineVersion")
.readerEndpoint(EndpointProperty.builder()
.address("address")
.port("port")
.build())
.securityGroupIds(List.of("securityGroupIds"))
.snapshotArnsToRestore(List.of("snapshotArnsToRestore"))
.snapshotRetentionLimit(123)
.subnetIds(List.of("subnetIds"))
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.userGroupId("userGroupId")
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnServerlessCachePropsstatic final classAn implementation forCfnServerlessCacheProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectThe cache usage limit for the serverless cache.default StringThe daily time that a cache snapshot will be created.default StringA description of the serverless cache.default ObjectRepresents the information required for client programs to connect to a cache node.The engine the serverless cache is compatible with.default StringThe name of the final snapshot taken of a cache before the cache is deleted.default ObjectThe ID of the AWS Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.default StringThe version number of the engine the serverless cache is compatible with.default ObjectRepresents the information required for client programs to connect to a cache node.The IDs of the EC2 security groups associated with the serverless cache.The unique identifier of the serverless cache.The ARN of the snapshot from which to restore data into the new cache.default NumberThe current setting for the number of serverless cache snapshots the system will retain.If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC.getTags()A list of tags to be added to this resource.default ObjectThe identifier of the user group associated with the serverless cache.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getEngine
The engine the serverless cache is compatible with.- See Also:
-
getServerlessCacheName
The unique identifier of the serverless cache.- See Also:
-
getCacheUsageLimits
The cache usage limit for the serverless cache.Returns union: either
IResolvableorCfnServerlessCache.CacheUsageLimitsProperty- See Also:
-
getDailySnapshotTime
The daily time that a cache snapshot will be created.Default is NULL, i.e. snapshots will not be created at a specific time on a daily basis. Available for Valkey, Redis OSS and Serverless Memcached only.
- See Also:
-
getDescription
A description of the serverless cache.- See Also:
-
getEndpoint
Represents the information required for client programs to connect to a cache node.This value is read-only.
Returns union: either
IResolvableorCfnServerlessCache.EndpointProperty- See Also:
-
getFinalSnapshotName
The name of the final snapshot taken of a cache before the cache is deleted.- See Also:
-
getKmsKeyId
The ID of the AWS Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.- See Also:
-
getMajorEngineVersion
The version number of the engine the serverless cache is compatible with.- See Also:
-
getReaderEndpoint
Represents the information required for client programs to connect to a cache node.This value is read-only.
Returns union: either
IResolvableorCfnServerlessCache.EndpointProperty- See Also:
-
getSecurityGroupIds
The IDs of the EC2 security groups associated with the serverless cache.Returns union: Listinvalid input: '<'either
StringorISecurityGroupRef>- See Also:
-
getSnapshotArnsToRestore
The ARN of the snapshot from which to restore data into the new cache.- See Also:
-
getSnapshotRetentionLimit
The current setting for the number of serverless cache snapshots the system will retain.Available for Valkey, Redis OSS and Serverless Memcached only.
- See Also:
-
getSubnetIds
If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC.For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.
Returns union: Listinvalid input: '<'either
StringorISubnetRef>- See Also:
-
getTags
A list of tags to be added to this resource.- See Also:
-
getUserGroupId
The identifier of the user group associated with the serverless cache.Available for Valkey and Redis OSS only. Default is NULL.
Returns union: either
StringorIUserGroupRef- See Also:
-
builder
- Returns:
- a
CfnServerlessCacheProps.BuilderofCfnServerlessCacheProps
-