1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. elasticache
  5. ServerlessCache

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.elasticache.ServerlessCache

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

The AWS::ElastiCache::ServerlessCache resource creates an Amazon ElastiCache Serverless Cache.

Create ServerlessCache Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ServerlessCache(name: string, args: ServerlessCacheArgs, opts?: CustomResourceOptions);
@overload
def ServerlessCache(resource_name: str,
                    args: ServerlessCacheArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def ServerlessCache(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    engine: Optional[str] = None,
                    reader_endpoint: Optional[ServerlessCacheEndpointArgs] = None,
                    snapshot_arns_to_restore: Optional[Sequence[str]] = None,
                    endpoint: Optional[ServerlessCacheEndpointArgs] = None,
                    daily_snapshot_time: Optional[str] = None,
                    final_snapshot_name: Optional[str] = None,
                    kms_key_id: Optional[str] = None,
                    description: Optional[str] = None,
                    security_group_ids: Optional[Sequence[str]] = None,
                    major_engine_version: Optional[str] = None,
                    serverless_cache_name: Optional[str] = None,
                    cache_usage_limits: Optional[ServerlessCacheCacheUsageLimitsArgs] = None,
                    snapshot_retention_limit: Optional[int] = None,
                    subnet_ids: Optional[Sequence[str]] = None,
                    tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                    user_group_id: Optional[str] = None)
func NewServerlessCache(ctx *Context, name string, args ServerlessCacheArgs, opts ...ResourceOption) (*ServerlessCache, error)
public ServerlessCache(string name, ServerlessCacheArgs args, CustomResourceOptions? opts = null)
public ServerlessCache(String name, ServerlessCacheArgs args)
public ServerlessCache(String name, ServerlessCacheArgs args, CustomResourceOptions options)
type: aws-native:elasticache:ServerlessCache
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ServerlessCacheArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ServerlessCacheArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ServerlessCacheArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ServerlessCacheArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ServerlessCacheArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ServerlessCache Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ServerlessCache resource accepts the following input properties:

Engine This property is required. string
The engine name of the Serverless Cache.
CacheUsageLimits Pulumi.AwsNative.ElastiCache.Inputs.ServerlessCacheCacheUsageLimits
The cache usage limit for the serverless cache.
DailySnapshotTime string
The daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.
Description string
The description of the Serverless Cache.
Endpoint Pulumi.AwsNative.ElastiCache.Inputs.ServerlessCacheEndpoint
Represents the information required for client programs to connect to a cache node. This value is read-only.
FinalSnapshotName string
The final snapshot name which is taken before Serverless Cache is deleted.
KmsKeyId string
The ID of the KMS key used to encrypt the cluster.
MajorEngineVersion string
The major engine version of the Serverless Cache.
ReaderEndpoint Pulumi.AwsNative.ElastiCache.Inputs.ServerlessCacheEndpoint
Represents the information required for client programs to connect to a cache node. This value is read-only.
SecurityGroupIds List<string>
One or more Amazon VPC security groups associated with this Serverless Cache.
ServerlessCacheName string
The name of the Serverless Cache. This value must be unique.
SnapshotArnsToRestore List<string>
The ARN's of snapshot to restore Serverless Cache.
SnapshotRetentionLimit int
The snapshot retention limit of the Serverless Cache.
SubnetIds List<string>
The subnet id's of the Serverless Cache.
Tags List<Pulumi.AwsNative.Inputs.Tag>
An array of key-value pairs to apply to this Serverless Cache.
UserGroupId string
The ID of the user group.
Engine This property is required. string
The engine name of the Serverless Cache.
CacheUsageLimits ServerlessCacheCacheUsageLimitsArgs
The cache usage limit for the serverless cache.
DailySnapshotTime string
The daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.
Description string
The description of the Serverless Cache.
Endpoint ServerlessCacheEndpointArgs
Represents the information required for client programs to connect to a cache node. This value is read-only.
FinalSnapshotName string
The final snapshot name which is taken before Serverless Cache is deleted.
KmsKeyId string
The ID of the KMS key used to encrypt the cluster.
MajorEngineVersion string
The major engine version of the Serverless Cache.
ReaderEndpoint ServerlessCacheEndpointArgs
Represents the information required for client programs to connect to a cache node. This value is read-only.
SecurityGroupIds []string
One or more Amazon VPC security groups associated with this Serverless Cache.
ServerlessCacheName string
The name of the Serverless Cache. This value must be unique.
SnapshotArnsToRestore []string
The ARN's of snapshot to restore Serverless Cache.
SnapshotRetentionLimit int
The snapshot retention limit of the Serverless Cache.
SubnetIds []string
The subnet id's of the Serverless Cache.
Tags TagArgs
An array of key-value pairs to apply to this Serverless Cache.
UserGroupId string
The ID of the user group.
engine This property is required. String
The engine name of the Serverless Cache.
cacheUsageLimits ServerlessCacheCacheUsageLimits
The cache usage limit for the serverless cache.
dailySnapshotTime String
The daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.
description String
The description of the Serverless Cache.
endpoint ServerlessCacheEndpoint
Represents the information required for client programs to connect to a cache node. This value is read-only.
finalSnapshotName String
The final snapshot name which is taken before Serverless Cache is deleted.
kmsKeyId String
The ID of the KMS key used to encrypt the cluster.
majorEngineVersion String
The major engine version of the Serverless Cache.
readerEndpoint ServerlessCacheEndpoint
Represents the information required for client programs to connect to a cache node. This value is read-only.
securityGroupIds List<String>
One or more Amazon VPC security groups associated with this Serverless Cache.
serverlessCacheName String
The name of the Serverless Cache. This value must be unique.
snapshotArnsToRestore List<String>
The ARN's of snapshot to restore Serverless Cache.
snapshotRetentionLimit Integer
The snapshot retention limit of the Serverless Cache.
subnetIds List<String>
The subnet id's of the Serverless Cache.
tags List<Tag>
An array of key-value pairs to apply to this Serverless Cache.
userGroupId String
The ID of the user group.
engine This property is required. string
The engine name of the Serverless Cache.
cacheUsageLimits ServerlessCacheCacheUsageLimits
The cache usage limit for the serverless cache.
dailySnapshotTime string
The daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.
description string
The description of the Serverless Cache.
endpoint ServerlessCacheEndpoint
Represents the information required for client programs to connect to a cache node. This value is read-only.
finalSnapshotName string
The final snapshot name which is taken before Serverless Cache is deleted.
kmsKeyId string
The ID of the KMS key used to encrypt the cluster.
majorEngineVersion string
The major engine version of the Serverless Cache.
readerEndpoint ServerlessCacheEndpoint
Represents the information required for client programs to connect to a cache node. This value is read-only.
securityGroupIds string[]
One or more Amazon VPC security groups associated with this Serverless Cache.
serverlessCacheName string
The name of the Serverless Cache. This value must be unique.
snapshotArnsToRestore string[]
The ARN's of snapshot to restore Serverless Cache.
snapshotRetentionLimit number
The snapshot retention limit of the Serverless Cache.
subnetIds string[]
The subnet id's of the Serverless Cache.
tags Tag[]
An array of key-value pairs to apply to this Serverless Cache.
userGroupId string
The ID of the user group.
engine This property is required. str
The engine name of the Serverless Cache.
cache_usage_limits ServerlessCacheCacheUsageLimitsArgs
The cache usage limit for the serverless cache.
daily_snapshot_time str
The daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.
description str
The description of the Serverless Cache.
endpoint ServerlessCacheEndpointArgs
Represents the information required for client programs to connect to a cache node. This value is read-only.
final_snapshot_name str
The final snapshot name which is taken before Serverless Cache is deleted.
kms_key_id str
The ID of the KMS key used to encrypt the cluster.
major_engine_version str
The major engine version of the Serverless Cache.
reader_endpoint ServerlessCacheEndpointArgs
Represents the information required for client programs to connect to a cache node. This value is read-only.
security_group_ids Sequence[str]
One or more Amazon VPC security groups associated with this Serverless Cache.
serverless_cache_name str
The name of the Serverless Cache. This value must be unique.
snapshot_arns_to_restore Sequence[str]
The ARN's of snapshot to restore Serverless Cache.
snapshot_retention_limit int
The snapshot retention limit of the Serverless Cache.
subnet_ids Sequence[str]
The subnet id's of the Serverless Cache.
tags Sequence[TagArgs]
An array of key-value pairs to apply to this Serverless Cache.
user_group_id str
The ID of the user group.
engine This property is required. String
The engine name of the Serverless Cache.
cacheUsageLimits Property Map
The cache usage limit for the serverless cache.
dailySnapshotTime String
The daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.
description String
The description of the Serverless Cache.
endpoint Property Map
Represents the information required for client programs to connect to a cache node. This value is read-only.
finalSnapshotName String
The final snapshot name which is taken before Serverless Cache is deleted.
kmsKeyId String
The ID of the KMS key used to encrypt the cluster.
majorEngineVersion String
The major engine version of the Serverless Cache.
readerEndpoint Property Map
Represents the information required for client programs to connect to a cache node. This value is read-only.
securityGroupIds List<String>
One or more Amazon VPC security groups associated with this Serverless Cache.
serverlessCacheName String
The name of the Serverless Cache. This value must be unique.
snapshotArnsToRestore List<String>
The ARN's of snapshot to restore Serverless Cache.
snapshotRetentionLimit Number
The snapshot retention limit of the Serverless Cache.
subnetIds List<String>
The subnet id's of the Serverless Cache.
tags List<Property Map>
An array of key-value pairs to apply to this Serverless Cache.
userGroupId String
The ID of the user group.

Outputs

All input properties are implicitly available as output properties. Additionally, the ServerlessCache resource produces the following output properties:

Arn string
The ARN of the Serverless Cache.
CreateTime string
The creation time of the Serverless Cache.
FullEngineVersion string
The full engine version of the Serverless Cache.
Id string
The provider-assigned unique ID for this managed resource.
Status string
The status of the Serverless Cache.
Arn string
The ARN of the Serverless Cache.
CreateTime string
The creation time of the Serverless Cache.
FullEngineVersion string
The full engine version of the Serverless Cache.
Id string
The provider-assigned unique ID for this managed resource.
Status string
The status of the Serverless Cache.
arn String
The ARN of the Serverless Cache.
createTime String
The creation time of the Serverless Cache.
fullEngineVersion String
The full engine version of the Serverless Cache.
id String
The provider-assigned unique ID for this managed resource.
status String
The status of the Serverless Cache.
arn string
The ARN of the Serverless Cache.
createTime string
The creation time of the Serverless Cache.
fullEngineVersion string
The full engine version of the Serverless Cache.
id string
The provider-assigned unique ID for this managed resource.
status string
The status of the Serverless Cache.
arn str
The ARN of the Serverless Cache.
create_time str
The creation time of the Serverless Cache.
full_engine_version str
The full engine version of the Serverless Cache.
id str
The provider-assigned unique ID for this managed resource.
status str
The status of the Serverless Cache.
arn String
The ARN of the Serverless Cache.
createTime String
The creation time of the Serverless Cache.
fullEngineVersion String
The full engine version of the Serverless Cache.
id String
The provider-assigned unique ID for this managed resource.
status String
The status of the Serverless Cache.

Supporting Types

ServerlessCacheCacheUsageLimits
, ServerlessCacheCacheUsageLimitsArgs

DataStorage Pulumi.AwsNative.ElastiCache.Inputs.ServerlessCacheDataStorage
The maximum data storage limit in the cache, expressed in Gigabytes.
EcpuPerSecond Pulumi.AwsNative.ElastiCache.Inputs.ServerlessCacheEcpuPerSecond
The number of ElastiCache Processing Units (ECPU) the cache can consume per second.
DataStorage ServerlessCacheDataStorage
The maximum data storage limit in the cache, expressed in Gigabytes.
EcpuPerSecond ServerlessCacheEcpuPerSecond
The number of ElastiCache Processing Units (ECPU) the cache can consume per second.
dataStorage ServerlessCacheDataStorage
The maximum data storage limit in the cache, expressed in Gigabytes.
ecpuPerSecond ServerlessCacheEcpuPerSecond
The number of ElastiCache Processing Units (ECPU) the cache can consume per second.
dataStorage ServerlessCacheDataStorage
The maximum data storage limit in the cache, expressed in Gigabytes.
ecpuPerSecond ServerlessCacheEcpuPerSecond
The number of ElastiCache Processing Units (ECPU) the cache can consume per second.
data_storage ServerlessCacheDataStorage
The maximum data storage limit in the cache, expressed in Gigabytes.
ecpu_per_second ServerlessCacheEcpuPerSecond
The number of ElastiCache Processing Units (ECPU) the cache can consume per second.
dataStorage Property Map
The maximum data storage limit in the cache, expressed in Gigabytes.
ecpuPerSecond Property Map
The number of ElastiCache Processing Units (ECPU) the cache can consume per second.

ServerlessCacheDataStorage
, ServerlessCacheDataStorageArgs

Unit This property is required. Pulumi.AwsNative.ElastiCache.ServerlessCacheDataStorageUnit
The unit of cached data capacity of the Serverless Cache.
Maximum int
The maximum cached data capacity of the Serverless Cache.
Minimum int
The minimum cached data capacity of the Serverless Cache.
Unit This property is required. ServerlessCacheDataStorageUnit
The unit of cached data capacity of the Serverless Cache.
Maximum int
The maximum cached data capacity of the Serverless Cache.
Minimum int
The minimum cached data capacity of the Serverless Cache.
unit This property is required. ServerlessCacheDataStorageUnit
The unit of cached data capacity of the Serverless Cache.
maximum Integer
The maximum cached data capacity of the Serverless Cache.
minimum Integer
The minimum cached data capacity of the Serverless Cache.
unit This property is required. ServerlessCacheDataStorageUnit
The unit of cached data capacity of the Serverless Cache.
maximum number
The maximum cached data capacity of the Serverless Cache.
minimum number
The minimum cached data capacity of the Serverless Cache.
unit This property is required. ServerlessCacheDataStorageUnit
The unit of cached data capacity of the Serverless Cache.
maximum int
The maximum cached data capacity of the Serverless Cache.
minimum int
The minimum cached data capacity of the Serverless Cache.
unit This property is required. "GB"
The unit of cached data capacity of the Serverless Cache.
maximum Number
The maximum cached data capacity of the Serverless Cache.
minimum Number
The minimum cached data capacity of the Serverless Cache.

ServerlessCacheDataStorageUnit
, ServerlessCacheDataStorageUnitArgs

Gb
GB
ServerlessCacheDataStorageUnitGb
GB
Gb
GB
Gb
GB
GB
GB
"GB"
GB

ServerlessCacheEcpuPerSecond
, ServerlessCacheEcpuPerSecondArgs

Maximum int
The maximum ECPU per second of the Serverless Cache.
Minimum int
The minimum ECPU per second of the Serverless Cache.
Maximum int
The maximum ECPU per second of the Serverless Cache.
Minimum int
The minimum ECPU per second of the Serverless Cache.
maximum Integer
The maximum ECPU per second of the Serverless Cache.
minimum Integer
The minimum ECPU per second of the Serverless Cache.
maximum number
The maximum ECPU per second of the Serverless Cache.
minimum number
The minimum ECPU per second of the Serverless Cache.
maximum int
The maximum ECPU per second of the Serverless Cache.
minimum int
The minimum ECPU per second of the Serverless Cache.
maximum Number
The maximum ECPU per second of the Serverless Cache.
minimum Number
The minimum ECPU per second of the Serverless Cache.

ServerlessCacheEndpoint
, ServerlessCacheEndpointArgs

Address string
Endpoint address.
Port string
Endpoint port.
Address string
Endpoint address.
Port string
Endpoint port.
address String
Endpoint address.
port String
Endpoint port.
address string
Endpoint address.
port string
Endpoint port.
address str
Endpoint address.
port str
Endpoint port.
address String
Endpoint address.
port String
Endpoint port.

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi