CfnServerlessCacheProps Struct
Properties for defining a CfnServerlessCache.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_elasticache as elasticache } from 'aws-cdk-lib';
const cfnServerlessCacheProps: elasticache.CfnServerlessCacheProps = {
engine: 'engine',
serverlessCacheName: 'serverlessCacheName',
// the properties below are optional
cacheUsageLimits: {
dataStorage: {
unit: 'unit',
// the properties below are optional
maximum: 123,
minimum: 123,
},
ecpuPerSecond: {
maximum: 123,
minimum: 123,
},
},
connectionType: 'connectionType',
dailySnapshotTime: 'dailySnapshotTime',
description: 'description',
endpoint: {
address: 'address',
port: 'port',
},
finalSnapshotName: 'finalSnapshotName',
kmsKeyId: 'kmsKeyId',
majorEngineVersion: 'majorEngineVersion',
networkType: 'networkType',
readerEndpoint: {
address: 'address',
port: 'port',
},
securityGroupIds: ['securityGroupIds'],
snapshotArnsToRestore: ['snapshotArnsToRestore'],
snapshotRetentionLimit: 123,
subnetIds: ['subnetIds'],
tags: [{
key: 'key',
value: 'value',
}],
userGroupId: 'userGroupId',
};
Properties
cacheUsageLimitsoptionalIResolvable | CfnServerlessCache.CacheUsageLimitsPropertycache_usage_limitsoptionaltyping.Union[IResolvable, CacheUsageLimitsProperty]cacheUsageLimitsoptionalIResolvableCacheUsageLimitsoptionalIResolvableCacheUsageLimitsoptionalinterface{}#The cache usage limit for the serverless cache.
connectionTypeoptionalstringconnection_typeoptionalstrconnectionTypeoptionalStringConnectionTypeoptionalstringConnectionTypeoptional*string#The connection type for the serverless cache.
Valid values are vpc or public.
dailySnapshotTimeoptionalstringdaily_snapshot_timeoptionalstrdailySnapshotTimeoptionalStringDailySnapshotTimeoptionalstringDailySnapshotTimeoptional*string#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.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#A description of the serverless cache.
endpointoptionalIResolvable | CfnServerlessCache.EndpointPropertyendpointoptionaltyping.Union[IResolvable, EndpointProperty]endpointoptionalIResolvableEndpointoptionalIResolvableEndpointoptionalinterface{}#Represents the information required for client programs to connect to a cache node.
This value is read-only.
The engine the serverless cache is compatible with.
finalSnapshotNameoptionalstringfinal_snapshot_nameoptionalstrfinalSnapshotNameoptionalStringFinalSnapshotNameoptionalstringFinalSnapshotNameoptional*string#The name of the final snapshot taken of a cache before the cache is deleted.
kmsKeyIdoptionalstring | IKeyRefkms_key_idoptionaltyping.Union[str, IKeyRef]kmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptionalinterface{}#The ID of the AWS Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.
majorEngineVersionoptionalstringmajor_engine_versionoptionalstrmajorEngineVersionoptionalStringMajorEngineVersionoptionalstringMajorEngineVersionoptional*string#The version number of the engine the serverless cache is compatible with.
networkTypeoptionalstringnetwork_typeoptionalstrnetworkTypeoptionalStringNetworkTypeoptionalstringNetworkTypeoptional*string#The network type for the serverless cache.
Valid values are ipv4, ipv6, or dual_stack.
readerEndpointoptionalIResolvable | CfnServerlessCache.EndpointPropertyreader_endpointoptionaltyping.Union[IResolvable, EndpointProperty]readerEndpointoptionalIResolvableReaderEndpointoptionalIResolvableReaderEndpointoptionalinterface{}#Represents the information required for client programs to connect to a cache node.
This value is read-only.
securityGroupIdsoptionalstring | ISecurityGroupRef[]security_group_idsoptionaltyping.List[typing.Union[str, ISecurityGroupRef]]securityGroupIdsoptionalList<String>SecurityGroupIdsoptionalstring[]SecurityGroupIdsoptional*[]interface{}#The IDs of the EC2 security groups associated with the serverless cache.
serverlessCacheNamestringserverless_cache_namestrserverlessCacheNameStringServerlessCacheNamestringServerlessCacheName*stringrequired#The unique identifier of the serverless cache.
snapshotArnsToRestoreoptionalstring[]snapshot_arns_to_restoreoptionaltyping.List[str]snapshotArnsToRestoreoptionalList<String>SnapshotArnsToRestoreoptionalstring[]SnapshotArnsToRestoreoptional*[]*string#The ARN of the snapshot from which to restore data into the new cache.
snapshotRetentionLimitoptionalnumbersnapshot_retention_limitoptionalint | floatsnapshotRetentionLimitoptionalNumberSnapshotRetentionLimitoptionaldoubleSnapshotRetentionLimitoptional*float64#The current setting for the number of serverless cache snapshots the system will retain.
Available for Valkey, Redis OSS and Serverless Memcached only.
subnetIdsoptionalstring | ISubnetRef[]subnet_idsoptionaltyping.List[typing.Union[str, ISubnetRef]]subnetIdsoptionalList<String>SubnetIdsoptionalstring[]SubnetIdsoptional*[]interface{}#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.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#A list of tags to be added to this resource.
userGroupIdoptionalstring | IUserGroupRefuser_group_idoptionaltyping.Union[str, IUserGroupRef]userGroupIdoptionalStringUserGroupIdoptionalstringUserGroupIdoptionalinterface{}#The identifier of the user group associated with the serverless cache.
Available for Valkey and Redis OSS only. Default is NULL.