CfnServerlessCache
- class aws_cdk.aws_elasticache.CfnServerlessCache(scope, id, *, engine, serverless_cache_name, cache_usage_limits=None, daily_snapshot_time=None, description=None, endpoint=None, final_snapshot_name=None, kms_key_id=None, major_engine_version=None, reader_endpoint=None, security_group_ids=None, snapshot_arns_to_restore=None, snapshot_retention_limit=None, subnet_ids=None, tags=None, user_group_id=None)
Bases:
CfnResource
The resource representing a serverless cache.
- See:
- CloudformationResource:
AWS::ElastiCache::ServerlessCache
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_elasticache as elasticache cfn_serverless_cache = elasticache.CfnServerlessCache(self, "MyCfnServerlessCache", engine="engine", serverless_cache_name="serverlessCacheName", # the properties below are optional cache_usage_limits=elasticache.CfnServerlessCache.CacheUsageLimitsProperty( data_storage=elasticache.CfnServerlessCache.DataStorageProperty( unit="unit", # the properties below are optional maximum=123, minimum=123 ), ecpu_per_second=elasticache.CfnServerlessCache.ECPUPerSecondProperty( maximum=123, minimum=123 ) ), daily_snapshot_time="dailySnapshotTime", description="description", endpoint=elasticache.CfnServerlessCache.EndpointProperty( address="address", port="port" ), final_snapshot_name="finalSnapshotName", kms_key_id="kmsKeyId", major_engine_version="majorEngineVersion", reader_endpoint=elasticache.CfnServerlessCache.EndpointProperty( address="address", port="port" ), security_group_ids=["securityGroupIds"], snapshot_arns_to_restore=["snapshotArnsToRestore"], snapshot_retention_limit=123, subnet_ids=["subnetIds"], tags=[CfnTag( key="key", value="value" )], user_group_id="userGroupId" )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).engine (
str
) – The engine the serverless cache is compatible with.serverless_cache_name (
str
) – The unique identifier of the serverless cache.cache_usage_limits (
Union
[IResolvable
,CacheUsageLimitsProperty
,Dict
[str
,Any
],None
]) – The cache usage limit for the serverless cache.daily_snapshot_time (
Optional
[str
]) – 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.description (
Optional
[str
]) – A description of the serverless cache.endpoint (
Union
[IResolvable
,EndpointProperty
,Dict
[str
,Any
],None
]) – Represents the information required for client programs to connect to a cache node. This value is read-only.final_snapshot_name (
Optional
[str
]) – The name of the final snapshot taken of a cache before the cache is deleted.kms_key_id (
Optional
[str
]) – The ID of the AWS Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.major_engine_version (
Optional
[str
]) – The version number of the engine the serverless cache is compatible with.reader_endpoint (
Union
[IResolvable
,EndpointProperty
,Dict
[str
,Any
],None
]) – Represents the information required for client programs to connect to a cache node. This value is read-only.security_group_ids (
Optional
[Sequence
[str
]]) – The IDs of the EC2 security groups associated with the serverless cache.snapshot_arns_to_restore (
Optional
[Sequence
[str
]]) – The ARN of the snapshot from which to restore data into the new cache.snapshot_retention_limit (
Union
[int
,float
,None
]) – The current setting for the number of serverless cache snapshots the system will retain. Available for Valkey, Redis OSS, and Serverless Memcached only.subnet_ids (
Optional
[Sequence
[str
]]) – 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.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – A list of tags to be added to this resource.user_group_id (
Optional
[str
]) – The identifier of the user group associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
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
). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT
). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.type_hint (
Optional
[ResolutionTypeHint
]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::ElastiCache::ServerlessCache'
- attr_arn
The Amazon Resource Name (ARN) of the serverless cache.
- CloudformationAttribute:
ARN
- attr_create_time
When the serverless cache was created.
- CloudformationAttribute:
CreateTime
- attr_endpoint_address
The DNS hostname of the cache node.
- CloudformationAttribute:
Endpoint.Address
- attr_endpoint_port
The port number that the cache engine is listening on.
- CloudformationAttribute:
Endpoint.Port
- attr_full_engine_version
The name and version number of the engine the serverless cache is compatible with.
- CloudformationAttribute:
FullEngineVersion
- attr_reader_endpoint_address
The DNS hostname of the cache node.
- CloudformationAttribute:
ReaderEndpoint.Address
- attr_reader_endpoint_port
The port number that the cache engine is listening on.
- CloudformationAttribute:
ReaderEndpoint.Port
- attr_status
The current status of the serverless cache.
The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
- CloudformationAttribute:
Status
- cache_usage_limits
The cache usage limit for the serverless cache.
- cdk_tag_manager
Tag Manager which manages the tags for this resource.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- daily_snapshot_time
The daily time that a cache snapshot will be created.
- description
A description of the serverless cache.
- endpoint
Represents the information required for client programs to connect to a cache node.
- engine
The engine the serverless cache is compatible with.
- final_snapshot_name
The name of the final snapshot taken of a cache before the cache is deleted.
- kms_key_id
The ID of the AWS Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- major_engine_version
The version number of the engine the serverless cache is compatible with.
- node
The tree node.
- reader_endpoint
Represents the information required for client programs to connect to a cache node.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- security_group_ids
The IDs of the EC2 security groups associated with the serverless cache.
- serverless_cache_name
The unique identifier of the serverless cache.
- snapshot_arns_to_restore
The ARN of the snapshot from which to restore data into the new cache.
- snapshot_retention_limit
The current setting for the number of serverless cache snapshots the system will retain.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- subnet_ids
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.
- tags
A list of tags to be added to this resource.
- user_group_id
The identifier of the user group associated with the serverless cache.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
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 classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
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 theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
CacheUsageLimitsProperty
- class CfnServerlessCache.CacheUsageLimitsProperty(*, data_storage=None, ecpu_per_second=None)
Bases:
object
The usage limits for storage and ElastiCache Processing Units for the cache.
- Parameters:
data_storage (
Union
[IResolvable
,DataStorageProperty
,Dict
[str
,Any
],None
]) – The maximum data storage limit in the cache, expressed in Gigabytes.ecpu_per_second (
Union
[IResolvable
,ECPUPerSecondProperty
,Dict
[str
,Any
],None
]) – The number of ElastiCache Processing Units (ECPU) the cache can consume per second.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_elasticache as elasticache cache_usage_limits_property = elasticache.CfnServerlessCache.CacheUsageLimitsProperty( data_storage=elasticache.CfnServerlessCache.DataStorageProperty( unit="unit", # the properties below are optional maximum=123, minimum=123 ), ecpu_per_second=elasticache.CfnServerlessCache.ECPUPerSecondProperty( maximum=123, minimum=123 ) )
Attributes
- data_storage
The maximum data storage limit in the cache, expressed in Gigabytes.
- ecpu_per_second
The number of ElastiCache Processing Units (ECPU) the cache can consume per second.
DataStorageProperty
- class CfnServerlessCache.DataStorageProperty(*, unit, maximum=None, minimum=None)
Bases:
object
The data storage limit.
- Parameters:
unit (
str
) – The unit that the storage is measured in, in GB.maximum (
Union
[int
,float
,None
]) – The upper limit for data storage the cache is set to use.minimum (
Union
[int
,float
,None
]) – The lower limit for data storage the cache is set to use.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_elasticache as elasticache data_storage_property = elasticache.CfnServerlessCache.DataStorageProperty( unit="unit", # the properties below are optional maximum=123, minimum=123 )
Attributes
- maximum
The upper limit for data storage the cache is set to use.
- minimum
The lower limit for data storage the cache is set to use.
- unit
The unit that the storage is measured in, in GB.
ECPUPerSecondProperty
- class CfnServerlessCache.ECPUPerSecondProperty(*, maximum=None, minimum=None)
Bases:
object
The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second.
- Parameters:
maximum (
Union
[int
,float
,None
]) – The configuration for the maximum number of ECPUs the cache can consume per second.minimum (
Union
[int
,float
,None
]) – The configuration for the minimum number of ECPUs the cache should be able consume per second.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_elasticache as elasticache e_cPUPer_second_property = elasticache.CfnServerlessCache.ECPUPerSecondProperty( maximum=123, minimum=123 )
Attributes
- maximum
The configuration for the maximum number of ECPUs the cache can consume per second.
- minimum
The configuration for the minimum number of ECPUs the cache should be able consume per second.
EndpointProperty
- class CfnServerlessCache.EndpointProperty(*, address=None, port=None)
Bases:
object
Represents the information required for client programs to connect to a cache node.
This value is read-only.
- Parameters:
address (
Optional
[str
]) – The DNS hostname of the cache node.port (
Optional
[str
]) – The port number that the cache engine is listening on.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_elasticache as elasticache endpoint_property = elasticache.CfnServerlessCache.EndpointProperty( address="address", port="port" )
Attributes
- address
The DNS hostname of the cache node.
- port
The port number that the cache engine is listening on.