@aws-cdk/aws-elasticache-alpha.ServerlessCacheBase

Experimental

@aws-cdk/aws-elasticache-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ServerlessCacheBase L2 construct

Base class for ServerlessCache constructs.

Construct›Resource›ServerlessCacheBase

implements

• IServerlessCache,
• IResource,
• IConnectable,
• IEnvironmentAware,
• 3 more

  • IServerlessCacheRef,
  • IConstruct,
  • IDependable

superclass of

• ServerlessCache

Stability

Experimental

Source

lib/serverless-cache-base.ts

Initializer

new ServerlessCacheBase(scope: Construct, id: string, props?: ResourceProps)

ServerlessCacheBase(scope: Construct, id: str, props: typing.Optional[ResourceProps] = None)

new ServerlessCacheBase(Construct scope, String id, ResourceProps props)

new ServerlessCacheBase(Construct scope, string id, ResourceProps? props = null)

NewServerlessCacheBase(Scope Construct, Id *string, Props ResourceProps)

Construct Props

account?optionalstringaccount?optionalstraccount?optionalStringAccount?optionalstringAccount?optional*string#

The AWS account ID this resource belongs to.

Default: the resource is in the same account as the stack it belongs to

environmentFromArn?optionalstringenvironment_from_arn?optionalstrenvironmentFromArn?optionalStringEnvironmentFromArn?optionalstringEnvironmentFromArn?optional*string#

ARN to deduce region and account from.

Default: take environment from account, region parameters, or use Stack environment.

The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources.

Cannot be supplied together with either account or region.

physicalName?optionalstringphysical_name?optionalstrphysicalName?optionalStringPhysicalName?optionalstringPhysicalName?optional*string#

The value passed in by users to the physical name prop of the resource.

Default: The physical name will be allocated by CloudFormation at deployment time

notes

• undefined implies that a physical name will be allocated by CloudFormation during deployment.
• a concrete value implies a specific physical name
• PhysicalName.GENERATE_IF_NEEDED is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.

region?optionalstringregion?optionalstrregion?optionalStringRegion?optionalstringRegion?optional*string#

The AWS region this resource belongs to.

Default: the resource is in the same region as the stack it belongs to

Properties

backupArnsToRestore?may be undefinedstring[]backup_arns_to_restore?may be undefinedtyping.List[str]backupArnsToRestore?may be undefinedList<String>BackupArnsToRestore?may be undefinedstring[]BackupArnsToRestore?may be undefined*[]*string#

The ARNs of backups restored in the cache.

connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnectionsrequired#

Access to network connections.

engine?may be undefinedCacheEngineengine?may be undefinedCacheEngineengine?may be undefinedCacheEngineEngine?may be undefinedCacheEngineEngine?may be undefinedCacheEngine#

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.

kmsKey?may be undefinedIKeykms_key?may be undefinedIKeykmsKey?may be undefinedIKeyKmsKey?may be undefinedIKeyKmsKey?may be undefinedIKey#

The KMS key used for encryption.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

securityGroups?may be undefinedISecurityGroup[]security_groups?may be undefinedtyping.List[ISecurityGroup]securityGroups?may be undefinedList<ISecurityGroup>SecurityGroups?may be undefinedISecurityGroup[]SecurityGroups?may be undefined*[]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.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

subnets?may be undefinedISubnet[]subnets?may be undefinedtyping.List[ISubnet]subnets?may be undefinedList<ISubnet>Subnets?may be undefinedISubnet[]Subnets?may be undefined*[]ISubnet#

The subnets this cache is deployed in.

userGroup?may be undefinedIUserGroupuser_group?may be undefinedIUserGroupuserGroup?may be undefinedIUserGroupUserGroup?may be undefinedIUserGroupUserGroup?may be undefinedIUserGroup#

The user group associated with this cache.

vpc?may be undefinedIVpcvpc?may be undefinedIVpcvpc?may be undefinedIVpcVpc?may be undefinedIVpcVpc?may be undefinedIVpc#

The VPC this cache is deployed in.

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).

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.

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.