Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. elasticache
  5. getServerlessCache
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.elasticache.getServerlessCache

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Use this data source to get information about an ElastiCache Serverless Cache.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.elasticache.getServerlessCache({
    name: "example",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.elasticache.get_serverless_cache(name="example")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/elasticache"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := elasticache.LookupServerlessCache(ctx, &elasticache.LookupServerlessCacheArgs{
			Name: "example",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.ElastiCache.GetServerlessCache.Invoke(new()
    {
        Name = "example",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.elasticache.ElasticacheFunctions;
import com.pulumi.aws.elasticache.inputs.GetServerlessCacheArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = ElasticacheFunctions.getServerlessCache(GetServerlessCacheArgs.builder()
            .name("example")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: aws:elasticache:getServerlessCache
      arguments:
        name: example
Copy

Using getServerlessCache

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getServerlessCache(args: GetServerlessCacheArgs, opts?: InvokeOptions): Promise<GetServerlessCacheResult>
function getServerlessCacheOutput(args: GetServerlessCacheOutputArgs, opts?: InvokeOptions): Output<GetServerlessCacheResult>
Copy
def get_serverless_cache(name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetServerlessCacheResult
def get_serverless_cache_output(name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetServerlessCacheResult]
Copy
func LookupServerlessCache(ctx *Context, args *LookupServerlessCacheArgs, opts ...InvokeOption) (*LookupServerlessCacheResult, error)
func LookupServerlessCacheOutput(ctx *Context, args *LookupServerlessCacheOutputArgs, opts ...InvokeOption) LookupServerlessCacheResultOutput
Copy

> Note: This function is named LookupServerlessCache in the Go SDK.

public static class GetServerlessCache 
{
    public static Task<GetServerlessCacheResult> InvokeAsync(GetServerlessCacheArgs args, InvokeOptions? opts = null)
    public static Output<GetServerlessCacheResult> Invoke(GetServerlessCacheInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetServerlessCacheResult> getServerlessCache(GetServerlessCacheArgs args, InvokeOptions options)
public static Output<GetServerlessCacheResult> getServerlessCache(GetServerlessCacheArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:elasticache/getServerlessCache:getServerlessCache
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Identifier for the serverless cache.
Name This property is required. string
Identifier for the serverless cache.
name This property is required. String
Identifier for the serverless cache.
name This property is required. string
Identifier for the serverless cache.
name This property is required. str
Identifier for the serverless cache.
name This property is required. String
Identifier for the serverless cache.

getServerlessCache Result

The following output properties are available:

Arn string
The Amazon Resource Name (ARN) of the serverless cache.
CacheUsageLimits GetServerlessCacheCacheUsageLimits
The cache usage limits for storage and ElastiCache Processing Units for the cache. See cache_usage_limits Block for details.
CreateTime string
Timestamp of when the serverless cache was created.
DailySnapshotTime string
The daily time that snapshots will be created from the new serverless cache. Only available for engine types "redis" and "valkey".
Description string
Description of the serverless cache.
Endpoint GetServerlessCacheEndpoint
Represents the information required for client programs to connect to the cache. See endpoint Block for details.
Engine string
Name of the cache engine.
FullEngineVersion string
The name and version number of the engine the serverless cache is compatible with.
Id string
The provider-assigned unique ID for this managed resource.
KmsKeyId string
ARN of the customer managed key for encrypting the data at rest.
MajorEngineVersion string
The version number of the engine the serverless cache is compatible with.
Name string
ReaderEndpoint GetServerlessCacheReaderEndpoint
Represents the information required for client programs to connect to a cache node. See reader_endpoint Block for details.
SecurityGroupIds List<string>
A list of the one or more VPC security groups associated with the serverless cache.
SnapshotRetentionLimit int
The number of snapshots that will be retained for the serverless cache. Available for Redis only.
Status string
The current status of the serverless cache.
SubnetIds List<string>
A list of the identifiers of the subnets where the VPC endpoint for the serverless cache are deployed.
UserGroupId string
The identifier of the UserGroup associated with the serverless cache. Available for Redis only.
Arn string
The Amazon Resource Name (ARN) of the serverless cache.
CacheUsageLimits GetServerlessCacheCacheUsageLimits
The cache usage limits for storage and ElastiCache Processing Units for the cache. See cache_usage_limits Block for details.
CreateTime string
Timestamp of when the serverless cache was created.
DailySnapshotTime string
The daily time that snapshots will be created from the new serverless cache. Only available for engine types "redis" and "valkey".
Description string
Description of the serverless cache.
Endpoint GetServerlessCacheEndpoint
Represents the information required for client programs to connect to the cache. See endpoint Block for details.
Engine string
Name of the cache engine.
FullEngineVersion string
The name and version number of the engine the serverless cache is compatible with.
Id string
The provider-assigned unique ID for this managed resource.
KmsKeyId string
ARN of the customer managed key for encrypting the data at rest.
MajorEngineVersion string
The version number of the engine the serverless cache is compatible with.
Name string
ReaderEndpoint GetServerlessCacheReaderEndpoint
Represents the information required for client programs to connect to a cache node. See reader_endpoint Block for details.
SecurityGroupIds []string
A list of the one or more VPC security groups associated with the serverless cache.
SnapshotRetentionLimit int
The number of snapshots that will be retained for the serverless cache. Available for Redis only.
Status string
The current status of the serverless cache.
SubnetIds []string
A list of the identifiers of the subnets where the VPC endpoint for the serverless cache are deployed.
UserGroupId string
The identifier of the UserGroup associated with the serverless cache. Available for Redis only.
arn String
The Amazon Resource Name (ARN) of the serverless cache.
cacheUsageLimits GetServerlessCacheCacheUsageLimits
The cache usage limits for storage and ElastiCache Processing Units for the cache. See cache_usage_limits Block for details.
createTime String
Timestamp of when the serverless cache was created.
dailySnapshotTime String
The daily time that snapshots will be created from the new serverless cache. Only available for engine types "redis" and "valkey".
description String
Description of the serverless cache.
endpoint GetServerlessCacheEndpoint
Represents the information required for client programs to connect to the cache. See endpoint Block for details.
engine String
Name of the cache engine.
fullEngineVersion String
The name and version number of the engine the serverless cache is compatible with.
id String
The provider-assigned unique ID for this managed resource.
kmsKeyId String
ARN of the customer managed key for encrypting the data at rest.
majorEngineVersion String
The version number of the engine the serverless cache is compatible with.
name String
readerEndpoint GetServerlessCacheReaderEndpoint
Represents the information required for client programs to connect to a cache node. See reader_endpoint Block for details.
securityGroupIds List<String>
A list of the one or more VPC security groups associated with the serverless cache.
snapshotRetentionLimit Integer
The number of snapshots that will be retained for the serverless cache. Available for Redis only.
status String
The current status of the serverless cache.
subnetIds List<String>
A list of the identifiers of the subnets where the VPC endpoint for the serverless cache are deployed.
userGroupId String
The identifier of the UserGroup associated with the serverless cache. Available for Redis only.
arn string
The Amazon Resource Name (ARN) of the serverless cache.
cacheUsageLimits GetServerlessCacheCacheUsageLimits
The cache usage limits for storage and ElastiCache Processing Units for the cache. See cache_usage_limits Block for details.
createTime string
Timestamp of when the serverless cache was created.
dailySnapshotTime string
The daily time that snapshots will be created from the new serverless cache. Only available for engine types "redis" and "valkey".
description string
Description of the serverless cache.
endpoint GetServerlessCacheEndpoint
Represents the information required for client programs to connect to the cache. See endpoint Block for details.
engine string
Name of the cache engine.
fullEngineVersion string
The name and version number of the engine the serverless cache is compatible with.
id string
The provider-assigned unique ID for this managed resource.
kmsKeyId string
ARN of the customer managed key for encrypting the data at rest.
majorEngineVersion string
The version number of the engine the serverless cache is compatible with.
name string
readerEndpoint GetServerlessCacheReaderEndpoint
Represents the information required for client programs to connect to a cache node. See reader_endpoint Block for details.
securityGroupIds string[]
A list of the one or more VPC security groups associated with the serverless cache.
snapshotRetentionLimit number
The number of snapshots that will be retained for the serverless cache. Available for Redis only.
status string
The current status of the serverless cache.
subnetIds string[]
A list of the identifiers of the subnets where the VPC endpoint for the serverless cache are deployed.
userGroupId string
The identifier of the UserGroup associated with the serverless cache. Available for Redis only.
arn str
The Amazon Resource Name (ARN) of the serverless cache.
cache_usage_limits GetServerlessCacheCacheUsageLimits
The cache usage limits for storage and ElastiCache Processing Units for the cache. See cache_usage_limits Block for details.
create_time str
Timestamp of when the serverless cache was created.
daily_snapshot_time str
The daily time that snapshots will be created from the new serverless cache. Only available for engine types "redis" and "valkey".
description str
Description of the serverless cache.
endpoint GetServerlessCacheEndpoint
Represents the information required for client programs to connect to the cache. See endpoint Block for details.
engine str
Name of the cache engine.
full_engine_version str
The name and version number of the engine the serverless cache is compatible with.
id str
The provider-assigned unique ID for this managed resource.
kms_key_id str
ARN of the customer managed key for encrypting the data at rest.
major_engine_version str
The version number of the engine the serverless cache is compatible with.
name str
reader_endpoint GetServerlessCacheReaderEndpoint
Represents the information required for client programs to connect to a cache node. See reader_endpoint Block for details.
security_group_ids Sequence[str]
A list of the one or more VPC security groups associated with the serverless cache.
snapshot_retention_limit int
The number of snapshots that will be retained for the serverless cache. Available for Redis only.
status str
The current status of the serverless cache.
subnet_ids Sequence[str]
A list of the identifiers of the subnets where the VPC endpoint for the serverless cache are deployed.
user_group_id str
The identifier of the UserGroup associated with the serverless cache. Available for Redis only.
arn String
The Amazon Resource Name (ARN) of the serverless cache.
cacheUsageLimits Property Map
The cache usage limits for storage and ElastiCache Processing Units for the cache. See cache_usage_limits Block for details.
createTime String
Timestamp of when the serverless cache was created.
dailySnapshotTime String
The daily time that snapshots will be created from the new serverless cache. Only available for engine types "redis" and "valkey".
description String
Description of the serverless cache.
endpoint Property Map
Represents the information required for client programs to connect to the cache. See endpoint Block for details.
engine String
Name of the cache engine.
fullEngineVersion String
The name and version number of the engine the serverless cache is compatible with.
id String
The provider-assigned unique ID for this managed resource.
kmsKeyId String
ARN of the customer managed key for encrypting the data at rest.
majorEngineVersion String
The version number of the engine the serverless cache is compatible with.
name String
readerEndpoint Property Map
Represents the information required for client programs to connect to a cache node. See reader_endpoint Block for details.
securityGroupIds List<String>
A list of the one or more VPC security groups associated with the serverless cache.
snapshotRetentionLimit Number
The number of snapshots that will be retained for the serverless cache. Available for Redis only.
status String
The current status of the serverless cache.
subnetIds List<String>
A list of the identifiers of the subnets where the VPC endpoint for the serverless cache are deployed.
userGroupId String
The identifier of the UserGroup associated with the serverless cache. Available for Redis only.

Supporting Types

GetServerlessCacheCacheUsageLimits

DataStorage This property is required. GetServerlessCacheCacheUsageLimitsDataStorage
The maximum data storage limit in the cache, expressed in Gigabytes. See data_storage Block for details.
EcpuPerSecond This property is required. GetServerlessCacheCacheUsageLimitsEcpuPerSecond
The configured number of ElastiCache Processing Units (ECPU) the cache can consume per second. See ecpu_per_second Block for details.
DataStorage This property is required. GetServerlessCacheCacheUsageLimitsDataStorage
The maximum data storage limit in the cache, expressed in Gigabytes. See data_storage Block for details.
EcpuPerSecond This property is required. GetServerlessCacheCacheUsageLimitsEcpuPerSecond
The configured number of ElastiCache Processing Units (ECPU) the cache can consume per second. See ecpu_per_second Block for details.
dataStorage This property is required. GetServerlessCacheCacheUsageLimitsDataStorage
The maximum data storage limit in the cache, expressed in Gigabytes. See data_storage Block for details.
ecpuPerSecond This property is required. GetServerlessCacheCacheUsageLimitsEcpuPerSecond
The configured number of ElastiCache Processing Units (ECPU) the cache can consume per second. See ecpu_per_second Block for details.
dataStorage This property is required. GetServerlessCacheCacheUsageLimitsDataStorage
The maximum data storage limit in the cache, expressed in Gigabytes. See data_storage Block for details.
ecpuPerSecond This property is required. GetServerlessCacheCacheUsageLimitsEcpuPerSecond
The configured number of ElastiCache Processing Units (ECPU) the cache can consume per second. See ecpu_per_second Block for details.
data_storage This property is required. GetServerlessCacheCacheUsageLimitsDataStorage
The maximum data storage limit in the cache, expressed in Gigabytes. See data_storage Block for details.
ecpu_per_second This property is required. GetServerlessCacheCacheUsageLimitsEcpuPerSecond
The configured number of ElastiCache Processing Units (ECPU) the cache can consume per second. See ecpu_per_second Block for details.
dataStorage This property is required. Property Map
The maximum data storage limit in the cache, expressed in Gigabytes. See data_storage Block for details.
ecpuPerSecond This property is required. Property Map
The configured number of ElastiCache Processing Units (ECPU) the cache can consume per second. See ecpu_per_second Block for details.

GetServerlessCacheCacheUsageLimitsDataStorage

Maximum This property is required. int
The maximum number of ECPUs the cache can consume per second.
Minimum This property is required. int
The minimum number of ECPUs the cache can consume per second.
Unit This property is required. string
The unit that the storage is measured in.
Maximum This property is required. int
The maximum number of ECPUs the cache can consume per second.
Minimum This property is required. int
The minimum number of ECPUs the cache can consume per second.
Unit This property is required. string
The unit that the storage is measured in.
maximum This property is required. Integer
The maximum number of ECPUs the cache can consume per second.
minimum This property is required. Integer
The minimum number of ECPUs the cache can consume per second.
unit This property is required. String
The unit that the storage is measured in.
maximum This property is required. number
The maximum number of ECPUs the cache can consume per second.
minimum This property is required. number
The minimum number of ECPUs the cache can consume per second.
unit This property is required. string
The unit that the storage is measured in.
maximum This property is required. int
The maximum number of ECPUs the cache can consume per second.
minimum This property is required. int
The minimum number of ECPUs the cache can consume per second.
unit This property is required. str
The unit that the storage is measured in.
maximum This property is required. Number
The maximum number of ECPUs the cache can consume per second.
minimum This property is required. Number
The minimum number of ECPUs the cache can consume per second.
unit This property is required. String
The unit that the storage is measured in.

GetServerlessCacheCacheUsageLimitsEcpuPerSecond

Maximum This property is required. int
The maximum number of ECPUs the cache can consume per second.
Minimum This property is required. int
The minimum number of ECPUs the cache can consume per second.
Maximum This property is required. int
The maximum number of ECPUs the cache can consume per second.
Minimum This property is required. int
The minimum number of ECPUs the cache can consume per second.
maximum This property is required. Integer
The maximum number of ECPUs the cache can consume per second.
minimum This property is required. Integer
The minimum number of ECPUs the cache can consume per second.
maximum This property is required. number
The maximum number of ECPUs the cache can consume per second.
minimum This property is required. number
The minimum number of ECPUs the cache can consume per second.
maximum This property is required. int
The maximum number of ECPUs the cache can consume per second.
minimum This property is required. int
The minimum number of ECPUs the cache can consume per second.
maximum This property is required. Number
The maximum number of ECPUs the cache can consume per second.
minimum This property is required. Number
The minimum number of ECPUs the cache can consume per second.

GetServerlessCacheEndpoint

Address This property is required. string
The DNS hostname of the cache node.
Port This property is required. int
The port number that the cache engine is listening on. Set as integer.
Address This property is required. string
The DNS hostname of the cache node.
Port This property is required. int
The port number that the cache engine is listening on. Set as integer.
address This property is required. String
The DNS hostname of the cache node.
port This property is required. Integer
The port number that the cache engine is listening on. Set as integer.
address This property is required. string
The DNS hostname of the cache node.
port This property is required. number
The port number that the cache engine is listening on. Set as integer.
address This property is required. str
The DNS hostname of the cache node.
port This property is required. int
The port number that the cache engine is listening on. Set as integer.
address This property is required. String
The DNS hostname of the cache node.
port This property is required. Number
The port number that the cache engine is listening on. Set as integer.

GetServerlessCacheReaderEndpoint

Address This property is required. string
The DNS hostname of the cache node.
Port This property is required. int
The port number that the cache engine is listening on. Set as integer.
Address This property is required. string
The DNS hostname of the cache node.
Port This property is required. int
The port number that the cache engine is listening on. Set as integer.
address This property is required. String
The DNS hostname of the cache node.
port This property is required. Integer
The port number that the cache engine is listening on. Set as integer.
address This property is required. string
The DNS hostname of the cache node.
port This property is required. number
The port number that the cache engine is listening on. Set as integer.
address This property is required. str
The DNS hostname of the cache node.
port This property is required. int
The port number that the cache engine is listening on. Set as integer.
address This property is required. String
The DNS hostname of the cache node.
port This property is required. Number
The port number that the cache engine is listening on. Set as integer.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws