IServerlessCache Interface
Represents a Serverless ElastiCache cache.
Properties
backupArnsToRestorestring[]backup_arns_to_restoretyping.List[str]backupArnsToRestoreList<String>BackupArnsToRestorestring[]BackupArnsToRestore*[]*string#The ARNs of backups restored in the cache.
connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnectionsrequired#The network connections associated with this resource.
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.
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.
serverlessCacheNamestringserverless_cache_namestrserverlessCacheNameStringServerlessCacheNamestringServerlessCacheName*stringrequired#The name of the serverless cache.
serverlessCacheRefServerlessCacheReferenceserverless_cache_refServerlessCacheReferenceserverlessCacheRefServerlessCacheReferenceServerlessCacheRefServerlessCacheReferenceServerlessCacheRefServerlessCacheReferencerequired#A reference to a ServerlessCache resource.
The stack in which this resource is defined.
The subnets this cache is deployed in.
The user group associated with this cache.
Methods
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).
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
1 parameter · returns
Parameters
mixinsmixinsmixinsmixinsMixins— The mixins to apply.
Returns: This construct for chaining