aws.elasticache.ServerlessCache
Explore with Pulumi AI
Provides an ElastiCache Serverless Cache resource which manages memcached, redis or valkey.
Example Usage
Memcached Serverless
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.elasticache.ServerlessCache("example", {
engine: "memcached",
name: "example",
cacheUsageLimits: {
dataStorage: {
maximum: 10,
unit: "GB",
},
ecpuPerSeconds: [{
maximum: 5000,
}],
},
description: "Test Server",
kmsKeyId: test.arn,
majorEngineVersion: "1.6",
securityGroupIds: [testAwsSecurityGroup.id],
subnetIds: testAwsSubnet.map(__item => __item.id),
});
import pulumi
import pulumi_aws as aws
example = aws.elasticache.ServerlessCache("example",
engine="memcached",
name="example",
cache_usage_limits={
"data_storage": {
"maximum": 10,
"unit": "GB",
},
"ecpu_per_seconds": [{
"maximum": 5000,
}],
},
description="Test Server",
kms_key_id=test["arn"],
major_engine_version="1.6",
security_group_ids=[test_aws_security_group["id"]],
subnet_ids=[__item["id"] for __item in test_aws_subnet])
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 {
var splat0 []interface{}
for _, val0 := range testAwsSubnet {
splat0 = append(splat0, val0.Id)
}
_, err := elasticache.NewServerlessCache(ctx, "example", &elasticache.ServerlessCacheArgs{
Engine: pulumi.String("memcached"),
Name: pulumi.String("example"),
CacheUsageLimits: &elasticache.ServerlessCacheCacheUsageLimitsArgs{
DataStorage: &elasticache.ServerlessCacheCacheUsageLimitsDataStorageArgs{
Maximum: pulumi.Int(10),
Unit: pulumi.String("GB"),
},
EcpuPerSeconds: elasticache.ServerlessCacheCacheUsageLimitsEcpuPerSecondArray{
&elasticache.ServerlessCacheCacheUsageLimitsEcpuPerSecondArgs{
Maximum: pulumi.Int(5000),
},
},
},
Description: pulumi.String("Test Server"),
KmsKeyId: pulumi.Any(test.Arn),
MajorEngineVersion: pulumi.String("1.6"),
SecurityGroupIds: pulumi.StringArray{
testAwsSecurityGroup.Id,
},
SubnetIds: toPulumiArray(splat0),
})
if err != nil {
return err
}
return nil
})
}
func toPulumiArray(arr []) pulumi.Array {
var pulumiArr pulumi.Array
for _, v := range arr {
pulumiArr = append(pulumiArr, pulumi.(v))
}
return pulumiArr
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.ElastiCache.ServerlessCache("example", new()
{
Engine = "memcached",
Name = "example",
CacheUsageLimits = new Aws.ElastiCache.Inputs.ServerlessCacheCacheUsageLimitsArgs
{
DataStorage = new Aws.ElastiCache.Inputs.ServerlessCacheCacheUsageLimitsDataStorageArgs
{
Maximum = 10,
Unit = "GB",
},
EcpuPerSeconds = new[]
{
new Aws.ElastiCache.Inputs.ServerlessCacheCacheUsageLimitsEcpuPerSecondArgs
{
Maximum = 5000,
},
},
},
Description = "Test Server",
KmsKeyId = test.Arn,
MajorEngineVersion = "1.6",
SecurityGroupIds = new[]
{
testAwsSecurityGroup.Id,
},
SubnetIds = testAwsSubnet.Select(__item => __item.Id).ToList(),
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.elasticache.ServerlessCache;
import com.pulumi.aws.elasticache.ServerlessCacheArgs;
import com.pulumi.aws.elasticache.inputs.ServerlessCacheCacheUsageLimitsArgs;
import com.pulumi.aws.elasticache.inputs.ServerlessCacheCacheUsageLimitsDataStorageArgs;
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) {
var example = new ServerlessCache("example", ServerlessCacheArgs.builder()
.engine("memcached")
.name("example")
.cacheUsageLimits(ServerlessCacheCacheUsageLimitsArgs.builder()
.dataStorage(ServerlessCacheCacheUsageLimitsDataStorageArgs.builder()
.maximum(10)
.unit("GB")
.build())
.ecpuPerSeconds(ServerlessCacheCacheUsageLimitsEcpuPerSecondArgs.builder()
.maximum(5000)
.build())
.build())
.description("Test Server")
.kmsKeyId(test.arn())
.majorEngineVersion("1.6")
.securityGroupIds(testAwsSecurityGroup.id())
.subnetIds(testAwsSubnet.stream().map(element -> element.id()).collect(toList()))
.build());
}
}
Coming soon!
Redis OSS Serverless
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.elasticache.ServerlessCache("example", {
engine: "redis",
name: "example",
cacheUsageLimits: {
dataStorage: {
maximum: 10,
unit: "GB",
},
ecpuPerSeconds: [{
maximum: 5000,
}],
},
dailySnapshotTime: "09:00",
description: "Test Server",
kmsKeyId: test.arn,
majorEngineVersion: "7",
snapshotRetentionLimit: 1,
securityGroupIds: [testAwsSecurityGroup.id],
subnetIds: testAwsSubnet.map(__item => __item.id),
});
import pulumi
import pulumi_aws as aws
example = aws.elasticache.ServerlessCache("example",
engine="redis",
name="example",
cache_usage_limits={
"data_storage": {
"maximum": 10,
"unit": "GB",
},
"ecpu_per_seconds": [{
"maximum": 5000,
}],
},
daily_snapshot_time="09:00",
description="Test Server",
kms_key_id=test["arn"],
major_engine_version="7",
snapshot_retention_limit=1,
security_group_ids=[test_aws_security_group["id"]],
subnet_ids=[__item["id"] for __item in test_aws_subnet])
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 {
var splat0 []interface{}
for _, val0 := range testAwsSubnet {
splat0 = append(splat0, val0.Id)
}
_, err := elasticache.NewServerlessCache(ctx, "example", &elasticache.ServerlessCacheArgs{
Engine: pulumi.String("redis"),
Name: pulumi.String("example"),
CacheUsageLimits: &elasticache.ServerlessCacheCacheUsageLimitsArgs{
DataStorage: &elasticache.ServerlessCacheCacheUsageLimitsDataStorageArgs{
Maximum: pulumi.Int(10),
Unit: pulumi.String("GB"),
},
EcpuPerSeconds: elasticache.ServerlessCacheCacheUsageLimitsEcpuPerSecondArray{
&elasticache.ServerlessCacheCacheUsageLimitsEcpuPerSecondArgs{
Maximum: pulumi.Int(5000),
},
},
},
DailySnapshotTime: pulumi.String("09:00"),
Description: pulumi.String("Test Server"),
KmsKeyId: pulumi.Any(test.Arn),
MajorEngineVersion: pulumi.String("7"),
SnapshotRetentionLimit: pulumi.Int(1),
SecurityGroupIds: pulumi.StringArray{
testAwsSecurityGroup.Id,
},
SubnetIds: toPulumiArray(splat0),
})
if err != nil {
return err
}
return nil
})
}
func toPulumiArray(arr []) pulumi.Array {
var pulumiArr pulumi.Array
for _, v := range arr {
pulumiArr = append(pulumiArr, pulumi.(v))
}
return pulumiArr
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.ElastiCache.ServerlessCache("example", new()
{
Engine = "redis",
Name = "example",
CacheUsageLimits = new Aws.ElastiCache.Inputs.ServerlessCacheCacheUsageLimitsArgs
{
DataStorage = new Aws.ElastiCache.Inputs.ServerlessCacheCacheUsageLimitsDataStorageArgs
{
Maximum = 10,
Unit = "GB",
},
EcpuPerSeconds = new[]
{
new Aws.ElastiCache.Inputs.ServerlessCacheCacheUsageLimitsEcpuPerSecondArgs
{
Maximum = 5000,
},
},
},
DailySnapshotTime = "09:00",
Description = "Test Server",
KmsKeyId = test.Arn,
MajorEngineVersion = "7",
SnapshotRetentionLimit = 1,
SecurityGroupIds = new[]
{
testAwsSecurityGroup.Id,
},
SubnetIds = testAwsSubnet.Select(__item => __item.Id).ToList(),
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.elasticache.ServerlessCache;
import com.pulumi.aws.elasticache.ServerlessCacheArgs;
import com.pulumi.aws.elasticache.inputs.ServerlessCacheCacheUsageLimitsArgs;
import com.pulumi.aws.elasticache.inputs.ServerlessCacheCacheUsageLimitsDataStorageArgs;
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) {
var example = new ServerlessCache("example", ServerlessCacheArgs.builder()
.engine("redis")
.name("example")
.cacheUsageLimits(ServerlessCacheCacheUsageLimitsArgs.builder()
.dataStorage(ServerlessCacheCacheUsageLimitsDataStorageArgs.builder()
.maximum(10)
.unit("GB")
.build())
.ecpuPerSeconds(ServerlessCacheCacheUsageLimitsEcpuPerSecondArgs.builder()
.maximum(5000)
.build())
.build())
.dailySnapshotTime("09:00")
.description("Test Server")
.kmsKeyId(test.arn())
.majorEngineVersion("7")
.snapshotRetentionLimit(1)
.securityGroupIds(testAwsSecurityGroup.id())
.subnetIds(testAwsSubnet.stream().map(element -> element.id()).collect(toList()))
.build());
}
}
Coming soon!
Valkey Serverless
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.elasticache.ServerlessCache("example", {
engine: "valkey",
name: "example",
cacheUsageLimits: {
dataStorage: {
maximum: 10,
unit: "GB",
},
ecpuPerSeconds: [{
maximum: 5000,
}],
},
dailySnapshotTime: "09:00",
description: "Test Server",
kmsKeyId: test.arn,
majorEngineVersion: "7",
snapshotRetentionLimit: 1,
securityGroupIds: [testAwsSecurityGroup.id],
subnetIds: testAwsSubnet.map(__item => __item.id),
});
import pulumi
import pulumi_aws as aws
example = aws.elasticache.ServerlessCache("example",
engine="valkey",
name="example",
cache_usage_limits={
"data_storage": {
"maximum": 10,
"unit": "GB",
},
"ecpu_per_seconds": [{
"maximum": 5000,
}],
},
daily_snapshot_time="09:00",
description="Test Server",
kms_key_id=test["arn"],
major_engine_version="7",
snapshot_retention_limit=1,
security_group_ids=[test_aws_security_group["id"]],
subnet_ids=[__item["id"] for __item in test_aws_subnet])
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 {
var splat0 []interface{}
for _, val0 := range testAwsSubnet {
splat0 = append(splat0, val0.Id)
}
_, err := elasticache.NewServerlessCache(ctx, "example", &elasticache.ServerlessCacheArgs{
Engine: pulumi.String("valkey"),
Name: pulumi.String("example"),
CacheUsageLimits: &elasticache.ServerlessCacheCacheUsageLimitsArgs{
DataStorage: &elasticache.ServerlessCacheCacheUsageLimitsDataStorageArgs{
Maximum: pulumi.Int(10),
Unit: pulumi.String("GB"),
},
EcpuPerSeconds: elasticache.ServerlessCacheCacheUsageLimitsEcpuPerSecondArray{
&elasticache.ServerlessCacheCacheUsageLimitsEcpuPerSecondArgs{
Maximum: pulumi.Int(5000),
},
},
},
DailySnapshotTime: pulumi.String("09:00"),
Description: pulumi.String("Test Server"),
KmsKeyId: pulumi.Any(test.Arn),
MajorEngineVersion: pulumi.String("7"),
SnapshotRetentionLimit: pulumi.Int(1),
SecurityGroupIds: pulumi.StringArray{
testAwsSecurityGroup.Id,
},
SubnetIds: toPulumiArray(splat0),
})
if err != nil {
return err
}
return nil
})
}
func toPulumiArray(arr []) pulumi.Array {
var pulumiArr pulumi.Array
for _, v := range arr {
pulumiArr = append(pulumiArr, pulumi.(v))
}
return pulumiArr
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.ElastiCache.ServerlessCache("example", new()
{
Engine = "valkey",
Name = "example",
CacheUsageLimits = new Aws.ElastiCache.Inputs.ServerlessCacheCacheUsageLimitsArgs
{
DataStorage = new Aws.ElastiCache.Inputs.ServerlessCacheCacheUsageLimitsDataStorageArgs
{
Maximum = 10,
Unit = "GB",
},
EcpuPerSeconds = new[]
{
new Aws.ElastiCache.Inputs.ServerlessCacheCacheUsageLimitsEcpuPerSecondArgs
{
Maximum = 5000,
},
},
},
DailySnapshotTime = "09:00",
Description = "Test Server",
KmsKeyId = test.Arn,
MajorEngineVersion = "7",
SnapshotRetentionLimit = 1,
SecurityGroupIds = new[]
{
testAwsSecurityGroup.Id,
},
SubnetIds = testAwsSubnet.Select(__item => __item.Id).ToList(),
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.elasticache.ServerlessCache;
import com.pulumi.aws.elasticache.ServerlessCacheArgs;
import com.pulumi.aws.elasticache.inputs.ServerlessCacheCacheUsageLimitsArgs;
import com.pulumi.aws.elasticache.inputs.ServerlessCacheCacheUsageLimitsDataStorageArgs;
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) {
var example = new ServerlessCache("example", ServerlessCacheArgs.builder()
.engine("valkey")
.name("example")
.cacheUsageLimits(ServerlessCacheCacheUsageLimitsArgs.builder()
.dataStorage(ServerlessCacheCacheUsageLimitsDataStorageArgs.builder()
.maximum(10)
.unit("GB")
.build())
.ecpuPerSeconds(ServerlessCacheCacheUsageLimitsEcpuPerSecondArgs.builder()
.maximum(5000)
.build())
.build())
.dailySnapshotTime("09:00")
.description("Test Server")
.kmsKeyId(test.arn())
.majorEngineVersion("7")
.snapshotRetentionLimit(1)
.securityGroupIds(testAwsSecurityGroup.id())
.subnetIds(testAwsSubnet.stream().map(element -> element.id()).collect(toList()))
.build());
}
}
Coming soon!
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,
name: Optional[str] = None,
description: Optional[str] = None,
daily_snapshot_time: Optional[str] = None,
kms_key_id: Optional[str] = None,
major_engine_version: Optional[str] = None,
cache_usage_limits: Optional[ServerlessCacheCacheUsageLimitsArgs] = None,
security_group_ids: Optional[Sequence[str]] = None,
snapshot_arns_to_restores: Optional[Sequence[str]] = None,
snapshot_retention_limit: Optional[int] = None,
subnet_ids: Optional[Sequence[str]] = None,
tags: Optional[Mapping[str, str]] = None,
timeouts: Optional[ServerlessCacheTimeoutsArgs] = 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:elasticache:ServerlessCache
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ServerlessCacheArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args ServerlessCacheArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServerlessCacheArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ServerlessCacheArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var serverlessCacheResource = new Aws.ElastiCache.ServerlessCache("serverlessCacheResource", new()
{
Engine = "string",
Name = "string",
Description = "string",
DailySnapshotTime = "string",
KmsKeyId = "string",
MajorEngineVersion = "string",
CacheUsageLimits = new Aws.ElastiCache.Inputs.ServerlessCacheCacheUsageLimitsArgs
{
DataStorage = new Aws.ElastiCache.Inputs.ServerlessCacheCacheUsageLimitsDataStorageArgs
{
Unit = "string",
Maximum = 0,
Minimum = 0,
},
EcpuPerSeconds = new[]
{
new Aws.ElastiCache.Inputs.ServerlessCacheCacheUsageLimitsEcpuPerSecondArgs
{
Maximum = 0,
Minimum = 0,
},
},
},
SecurityGroupIds = new[]
{
"string",
},
SnapshotArnsToRestores = new[]
{
"string",
},
SnapshotRetentionLimit = 0,
SubnetIds = new[]
{
"string",
},
Tags =
{
{ "string", "string" },
},
Timeouts = new Aws.ElastiCache.Inputs.ServerlessCacheTimeoutsArgs
{
Create = "string",
Delete = "string",
Update = "string",
},
UserGroupId = "string",
});
example, err := elasticache.NewServerlessCache(ctx, "serverlessCacheResource", &elasticache.ServerlessCacheArgs{
Engine: pulumi.String("string"),
Name: pulumi.String("string"),
Description: pulumi.String("string"),
DailySnapshotTime: pulumi.String("string"),
KmsKeyId: pulumi.String("string"),
MajorEngineVersion: pulumi.String("string"),
CacheUsageLimits: &elasticache.ServerlessCacheCacheUsageLimitsArgs{
DataStorage: &elasticache.ServerlessCacheCacheUsageLimitsDataStorageArgs{
Unit: pulumi.String("string"),
Maximum: pulumi.Int(0),
Minimum: pulumi.Int(0),
},
EcpuPerSeconds: elasticache.ServerlessCacheCacheUsageLimitsEcpuPerSecondArray{
&elasticache.ServerlessCacheCacheUsageLimitsEcpuPerSecondArgs{
Maximum: pulumi.Int(0),
Minimum: pulumi.Int(0),
},
},
},
SecurityGroupIds: pulumi.StringArray{
pulumi.String("string"),
},
SnapshotArnsToRestores: pulumi.StringArray{
pulumi.String("string"),
},
SnapshotRetentionLimit: pulumi.Int(0),
SubnetIds: pulumi.StringArray{
pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Timeouts: &elasticache.ServerlessCacheTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
UserGroupId: pulumi.String("string"),
})
var serverlessCacheResource = new ServerlessCache("serverlessCacheResource", ServerlessCacheArgs.builder()
.engine("string")
.name("string")
.description("string")
.dailySnapshotTime("string")
.kmsKeyId("string")
.majorEngineVersion("string")
.cacheUsageLimits(ServerlessCacheCacheUsageLimitsArgs.builder()
.dataStorage(ServerlessCacheCacheUsageLimitsDataStorageArgs.builder()
.unit("string")
.maximum(0)
.minimum(0)
.build())
.ecpuPerSeconds(ServerlessCacheCacheUsageLimitsEcpuPerSecondArgs.builder()
.maximum(0)
.minimum(0)
.build())
.build())
.securityGroupIds("string")
.snapshotArnsToRestores("string")
.snapshotRetentionLimit(0)
.subnetIds("string")
.tags(Map.of("string", "string"))
.timeouts(ServerlessCacheTimeoutsArgs.builder()
.create("string")
.delete("string")
.update("string")
.build())
.userGroupId("string")
.build());
serverless_cache_resource = aws.elasticache.ServerlessCache("serverlessCacheResource",
engine="string",
name="string",
description="string",
daily_snapshot_time="string",
kms_key_id="string",
major_engine_version="string",
cache_usage_limits={
"data_storage": {
"unit": "string",
"maximum": 0,
"minimum": 0,
},
"ecpu_per_seconds": [{
"maximum": 0,
"minimum": 0,
}],
},
security_group_ids=["string"],
snapshot_arns_to_restores=["string"],
snapshot_retention_limit=0,
subnet_ids=["string"],
tags={
"string": "string",
},
timeouts={
"create": "string",
"delete": "string",
"update": "string",
},
user_group_id="string")
const serverlessCacheResource = new aws.elasticache.ServerlessCache("serverlessCacheResource", {
engine: "string",
name: "string",
description: "string",
dailySnapshotTime: "string",
kmsKeyId: "string",
majorEngineVersion: "string",
cacheUsageLimits: {
dataStorage: {
unit: "string",
maximum: 0,
minimum: 0,
},
ecpuPerSeconds: [{
maximum: 0,
minimum: 0,
}],
},
securityGroupIds: ["string"],
snapshotArnsToRestores: ["string"],
snapshotRetentionLimit: 0,
subnetIds: ["string"],
tags: {
string: "string",
},
timeouts: {
create: "string",
"delete": "string",
update: "string",
},
userGroupId: "string",
});
type: aws:elasticache:ServerlessCache
properties:
cacheUsageLimits:
dataStorage:
maximum: 0
minimum: 0
unit: string
ecpuPerSeconds:
- maximum: 0
minimum: 0
dailySnapshotTime: string
description: string
engine: string
kmsKeyId: string
majorEngineVersion: string
name: string
securityGroupIds:
- string
snapshotArnsToRestores:
- string
snapshotRetentionLimit: 0
subnetIds:
- string
tags:
string: string
timeouts:
create: string
delete: string
update: string
userGroupId: string
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 string
- Name of the cache engine to be used for this cache cluster. Valid values are
memcached
,redis
orvalkey
. - Cache
Usage ServerlessLimits Cache Cache Usage Limits - Sets the cache usage limits for storage and ElastiCache Processing Units for the cache. See
cache_usage_limits
Block for details. - Daily
Snapshot stringTime - The daily time that snapshots will be created from the new serverless cache. Only supported for engine types
"redis"
or"valkey"
. Defaults to0
. - Description string
- User-provided description for the serverless cache. The default is NULL.
- Kms
Key stringId - ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.
- Major
Engine stringVersion - The version of the cache engine that will be used to create the serverless cache. See Describe Cache Engine Versions in the AWS Documentation for supported versions.
- Name string
The Cluster name which serves as a unique identifier to the serverless cache
The following arguments are optional:
- Security
Group List<string>Ids - A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.
- Snapshot
Arns List<string>To Restores - The list of ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis only.
- Snapshot
Retention intLimit - The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only.
- Subnet
Ids List<string> - A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.
- Dictionary<string, string>
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Timeouts
Serverless
Cache Timeouts - User
Group stringId - The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL.
- Engine string
- Name of the cache engine to be used for this cache cluster. Valid values are
memcached
,redis
orvalkey
. - Cache
Usage ServerlessLimits Cache Cache Usage Limits Args - Sets the cache usage limits for storage and ElastiCache Processing Units for the cache. See
cache_usage_limits
Block for details. - Daily
Snapshot stringTime - The daily time that snapshots will be created from the new serverless cache. Only supported for engine types
"redis"
or"valkey"
. Defaults to0
. - Description string
- User-provided description for the serverless cache. The default is NULL.
- Kms
Key stringId - ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.
- Major
Engine stringVersion - The version of the cache engine that will be used to create the serverless cache. See Describe Cache Engine Versions in the AWS Documentation for supported versions.
- Name string
The Cluster name which serves as a unique identifier to the serverless cache
The following arguments are optional:
- Security
Group []stringIds - A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.
- Snapshot
Arns []stringTo Restores - The list of ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis only.
- Snapshot
Retention intLimit - The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only.
- Subnet
Ids []string - A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.
- map[string]string
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Timeouts
Serverless
Cache Timeouts Args - User
Group stringId - The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL.
- engine String
- Name of the cache engine to be used for this cache cluster. Valid values are
memcached
,redis
orvalkey
. - cache
Usage ServerlessLimits Cache Cache Usage Limits - Sets the cache usage limits for storage and ElastiCache Processing Units for the cache. See
cache_usage_limits
Block for details. - daily
Snapshot StringTime - The daily time that snapshots will be created from the new serverless cache. Only supported for engine types
"redis"
or"valkey"
. Defaults to0
. - description String
- User-provided description for the serverless cache. The default is NULL.
- kms
Key StringId - ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.
- major
Engine StringVersion - The version of the cache engine that will be used to create the serverless cache. See Describe Cache Engine Versions in the AWS Documentation for supported versions.
- name String
The Cluster name which serves as a unique identifier to the serverless cache
The following arguments are optional:
- security
Group List<String>Ids - A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.
- snapshot
Arns List<String>To Restores - The list of ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis only.
- snapshot
Retention IntegerLimit - The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only.
- subnet
Ids List<String> - A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.
- Map<String,String>
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts
Serverless
Cache Timeouts - user
Group StringId - The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL.
- engine string
- Name of the cache engine to be used for this cache cluster. Valid values are
memcached
,redis
orvalkey
. - cache
Usage ServerlessLimits Cache Cache Usage Limits - Sets the cache usage limits for storage and ElastiCache Processing Units for the cache. See
cache_usage_limits
Block for details. - daily
Snapshot stringTime - The daily time that snapshots will be created from the new serverless cache. Only supported for engine types
"redis"
or"valkey"
. Defaults to0
. - description string
- User-provided description for the serverless cache. The default is NULL.
- kms
Key stringId - ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.
- major
Engine stringVersion - The version of the cache engine that will be used to create the serverless cache. See Describe Cache Engine Versions in the AWS Documentation for supported versions.
- name string
The Cluster name which serves as a unique identifier to the serverless cache
The following arguments are optional:
- security
Group string[]Ids - A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.
- snapshot
Arns string[]To Restores - The list of ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis only.
- snapshot
Retention numberLimit - The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only.
- subnet
Ids string[] - A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.
- {[key: string]: string}
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts
Serverless
Cache Timeouts - user
Group stringId - The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL.
- engine str
- Name of the cache engine to be used for this cache cluster. Valid values are
memcached
,redis
orvalkey
. - cache_
usage_ Serverlesslimits Cache Cache Usage Limits Args - Sets the cache usage limits for storage and ElastiCache Processing Units for the cache. See
cache_usage_limits
Block for details. - daily_
snapshot_ strtime - The daily time that snapshots will be created from the new serverless cache. Only supported for engine types
"redis"
or"valkey"
. Defaults to0
. - description str
- User-provided description for the serverless cache. The default is NULL.
- kms_
key_ strid - ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.
- major_
engine_ strversion - The version of the cache engine that will be used to create the serverless cache. See Describe Cache Engine Versions in the AWS Documentation for supported versions.
- name str
The Cluster name which serves as a unique identifier to the serverless cache
The following arguments are optional:
- security_
group_ Sequence[str]ids - A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.
- snapshot_
arns_ Sequence[str]to_ restores - The list of ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis only.
- snapshot_
retention_ intlimit - The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only.
- subnet_
ids Sequence[str] - A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.
- Mapping[str, str]
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts
Serverless
Cache Timeouts Args - user_
group_ strid - The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL.
- engine String
- Name of the cache engine to be used for this cache cluster. Valid values are
memcached
,redis
orvalkey
. - cache
Usage Property MapLimits - Sets the cache usage limits for storage and ElastiCache Processing Units for the cache. See
cache_usage_limits
Block for details. - daily
Snapshot StringTime - The daily time that snapshots will be created from the new serverless cache. Only supported for engine types
"redis"
or"valkey"
. Defaults to0
. - description String
- User-provided description for the serverless cache. The default is NULL.
- kms
Key StringId - ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.
- major
Engine StringVersion - The version of the cache engine that will be used to create the serverless cache. See Describe Cache Engine Versions in the AWS Documentation for supported versions.
- name String
The Cluster name which serves as a unique identifier to the serverless cache
The following arguments are optional:
- security
Group List<String>Ids - A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.
- snapshot
Arns List<String>To Restores - The list of ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis only.
- snapshot
Retention NumberLimit - The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only.
- subnet
Ids List<String> - A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.
- Map<String>
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts Property Map
- user
Group StringId - The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL.
Outputs
All input properties are implicitly available as output properties. Additionally, the ServerlessCache resource produces the following output properties:
- Arn string
- The Amazon Resource Name (ARN) of the serverless cache.
- Create
Time string - Timestamp of when the serverless cache was created.
- Endpoints
List<Serverless
Cache Endpoint> - Represents the information required for client programs to connect to a cache node. See
endpoint
Block for details. - Full
Engine stringVersion - 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.
- Reader
Endpoints List<ServerlessCache Reader Endpoint> - Represents the information required for client programs to connect to a cache node. See
reader_endpoint
Block for details. - Status string
- The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
- Dictionary<string, string>
- Arn string
- The Amazon Resource Name (ARN) of the serverless cache.
- Create
Time string - Timestamp of when the serverless cache was created.
- Endpoints
[]Serverless
Cache Endpoint - Represents the information required for client programs to connect to a cache node. See
endpoint
Block for details. - Full
Engine stringVersion - 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.
- Reader
Endpoints []ServerlessCache Reader Endpoint - Represents the information required for client programs to connect to a cache node. See
reader_endpoint
Block for details. - Status string
- The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
- map[string]string
- arn String
- The Amazon Resource Name (ARN) of the serverless cache.
- create
Time String - Timestamp of when the serverless cache was created.
- endpoints
List<Serverless
Cache Endpoint> - Represents the information required for client programs to connect to a cache node. See
endpoint
Block for details. - full
Engine StringVersion - 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.
- reader
Endpoints List<ServerlessCache Reader Endpoint> - Represents the information required for client programs to connect to a cache node. See
reader_endpoint
Block for details. - status String
- The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
- Map<String,String>
- arn string
- The Amazon Resource Name (ARN) of the serverless cache.
- create
Time string - Timestamp of when the serverless cache was created.
- endpoints
Serverless
Cache Endpoint[] - Represents the information required for client programs to connect to a cache node. See
endpoint
Block for details. - full
Engine stringVersion - 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.
- reader
Endpoints ServerlessCache Reader Endpoint[] - Represents the information required for client programs to connect to a cache node. See
reader_endpoint
Block for details. - status string
- The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
- {[key: string]: string}
- arn str
- The Amazon Resource Name (ARN) of the serverless cache.
- create_
time str - Timestamp of when the serverless cache was created.
- endpoints
Sequence[Serverless
Cache Endpoint] - Represents the information required for client programs to connect to a cache node. See
endpoint
Block for details. - full_
engine_ strversion - 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.
- reader_
endpoints Sequence[ServerlessCache Reader Endpoint] - Represents the information required for client programs to connect to a cache node. See
reader_endpoint
Block for details. - status str
- The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
- Mapping[str, str]
- arn String
- The Amazon Resource Name (ARN) of the serverless cache.
- create
Time String - Timestamp of when the serverless cache was created.
- endpoints List<Property Map>
- Represents the information required for client programs to connect to a cache node. See
endpoint
Block for details. - full
Engine StringVersion - 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.
- reader
Endpoints List<Property Map> - Represents the information required for client programs to connect to a cache node. See
reader_endpoint
Block for details. - status String
- The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
- Map<String>
Look up Existing ServerlessCache Resource
Get an existing ServerlessCache resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ServerlessCacheState, opts?: CustomResourceOptions): ServerlessCache
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
cache_usage_limits: Optional[ServerlessCacheCacheUsageLimitsArgs] = None,
create_time: Optional[str] = None,
daily_snapshot_time: Optional[str] = None,
description: Optional[str] = None,
endpoints: Optional[Sequence[ServerlessCacheEndpointArgs]] = None,
engine: Optional[str] = None,
full_engine_version: Optional[str] = None,
kms_key_id: Optional[str] = None,
major_engine_version: Optional[str] = None,
name: Optional[str] = None,
reader_endpoints: Optional[Sequence[ServerlessCacheReaderEndpointArgs]] = None,
security_group_ids: Optional[Sequence[str]] = None,
snapshot_arns_to_restores: Optional[Sequence[str]] = None,
snapshot_retention_limit: Optional[int] = None,
status: Optional[str] = None,
subnet_ids: Optional[Sequence[str]] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
timeouts: Optional[ServerlessCacheTimeoutsArgs] = None,
user_group_id: Optional[str] = None) -> ServerlessCache
func GetServerlessCache(ctx *Context, name string, id IDInput, state *ServerlessCacheState, opts ...ResourceOption) (*ServerlessCache, error)
public static ServerlessCache Get(string name, Input<string> id, ServerlessCacheState? state, CustomResourceOptions? opts = null)
public static ServerlessCache get(String name, Output<String> id, ServerlessCacheState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- The Amazon Resource Name (ARN) of the serverless cache.
- Cache
Usage ServerlessLimits Cache Cache Usage Limits - Sets the cache usage limits for storage and ElastiCache Processing Units for the cache. See
cache_usage_limits
Block for details. - Create
Time string - Timestamp of when the serverless cache was created.
- Daily
Snapshot stringTime - The daily time that snapshots will be created from the new serverless cache. Only supported for engine types
"redis"
or"valkey"
. Defaults to0
. - Description string
- User-provided description for the serverless cache. The default is NULL.
- Endpoints
List<Serverless
Cache Endpoint> - Represents the information required for client programs to connect to a cache node. See
endpoint
Block for details. - Engine string
- Name of the cache engine to be used for this cache cluster. Valid values are
memcached
,redis
orvalkey
. - Full
Engine stringVersion - The name and version number of the engine the serverless cache is compatible with.
- Kms
Key stringId - ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.
- Major
Engine stringVersion - The version of the cache engine that will be used to create the serverless cache. See Describe Cache Engine Versions in the AWS Documentation for supported versions.
- Name string
The Cluster name which serves as a unique identifier to the serverless cache
The following arguments are optional:
- Reader
Endpoints List<ServerlessCache Reader Endpoint> - Represents the information required for client programs to connect to a cache node. See
reader_endpoint
Block for details. - Security
Group List<string>Ids - A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.
- Snapshot
Arns List<string>To Restores - The list of ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis only.
- Snapshot
Retention intLimit - The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only.
- Status string
- The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
- Subnet
Ids List<string> - A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.
- Dictionary<string, string>
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- Timeouts
Serverless
Cache Timeouts - User
Group stringId - The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL.
- Arn string
- The Amazon Resource Name (ARN) of the serverless cache.
- Cache
Usage ServerlessLimits Cache Cache Usage Limits Args - Sets the cache usage limits for storage and ElastiCache Processing Units for the cache. See
cache_usage_limits
Block for details. - Create
Time string - Timestamp of when the serverless cache was created.
- Daily
Snapshot stringTime - The daily time that snapshots will be created from the new serverless cache. Only supported for engine types
"redis"
or"valkey"
. Defaults to0
. - Description string
- User-provided description for the serverless cache. The default is NULL.
- Endpoints
[]Serverless
Cache Endpoint Args - Represents the information required for client programs to connect to a cache node. See
endpoint
Block for details. - Engine string
- Name of the cache engine to be used for this cache cluster. Valid values are
memcached
,redis
orvalkey
. - Full
Engine stringVersion - The name and version number of the engine the serverless cache is compatible with.
- Kms
Key stringId - ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.
- Major
Engine stringVersion - The version of the cache engine that will be used to create the serverless cache. See Describe Cache Engine Versions in the AWS Documentation for supported versions.
- Name string
The Cluster name which serves as a unique identifier to the serverless cache
The following arguments are optional:
- Reader
Endpoints []ServerlessCache Reader Endpoint Args - Represents the information required for client programs to connect to a cache node. See
reader_endpoint
Block for details. - Security
Group []stringIds - A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.
- Snapshot
Arns []stringTo Restores - The list of ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis only.
- Snapshot
Retention intLimit - The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only.
- Status string
- The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
- Subnet
Ids []string - A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.
- map[string]string
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- Timeouts
Serverless
Cache Timeouts Args - User
Group stringId - The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL.
- arn String
- The Amazon Resource Name (ARN) of the serverless cache.
- cache
Usage ServerlessLimits Cache Cache Usage Limits - Sets the cache usage limits for storage and ElastiCache Processing Units for the cache. See
cache_usage_limits
Block for details. - create
Time String - Timestamp of when the serverless cache was created.
- daily
Snapshot StringTime - The daily time that snapshots will be created from the new serverless cache. Only supported for engine types
"redis"
or"valkey"
. Defaults to0
. - description String
- User-provided description for the serverless cache. The default is NULL.
- endpoints
List<Serverless
Cache Endpoint> - Represents the information required for client programs to connect to a cache node. See
endpoint
Block for details. - engine String
- Name of the cache engine to be used for this cache cluster. Valid values are
memcached
,redis
orvalkey
. - full
Engine StringVersion - The name and version number of the engine the serverless cache is compatible with.
- kms
Key StringId - ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.
- major
Engine StringVersion - The version of the cache engine that will be used to create the serverless cache. See Describe Cache Engine Versions in the AWS Documentation for supported versions.
- name String
The Cluster name which serves as a unique identifier to the serverless cache
The following arguments are optional:
- reader
Endpoints List<ServerlessCache Reader Endpoint> - Represents the information required for client programs to connect to a cache node. See
reader_endpoint
Block for details. - security
Group List<String>Ids - A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.
- snapshot
Arns List<String>To Restores - The list of ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis only.
- snapshot
Retention IntegerLimit - The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only.
- status String
- The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
- subnet
Ids List<String> - A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.
- Map<String,String>
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- timeouts
Serverless
Cache Timeouts - user
Group StringId - The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL.
- arn string
- The Amazon Resource Name (ARN) of the serverless cache.
- cache
Usage ServerlessLimits Cache Cache Usage Limits - Sets the cache usage limits for storage and ElastiCache Processing Units for the cache. See
cache_usage_limits
Block for details. - create
Time string - Timestamp of when the serverless cache was created.
- daily
Snapshot stringTime - The daily time that snapshots will be created from the new serverless cache. Only supported for engine types
"redis"
or"valkey"
. Defaults to0
. - description string
- User-provided description for the serverless cache. The default is NULL.
- endpoints
Serverless
Cache Endpoint[] - Represents the information required for client programs to connect to a cache node. See
endpoint
Block for details. - engine string
- Name of the cache engine to be used for this cache cluster. Valid values are
memcached
,redis
orvalkey
. - full
Engine stringVersion - The name and version number of the engine the serverless cache is compatible with.
- kms
Key stringId - ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.
- major
Engine stringVersion - The version of the cache engine that will be used to create the serverless cache. See Describe Cache Engine Versions in the AWS Documentation for supported versions.
- name string
The Cluster name which serves as a unique identifier to the serverless cache
The following arguments are optional:
- reader
Endpoints ServerlessCache Reader Endpoint[] - Represents the information required for client programs to connect to a cache node. See
reader_endpoint
Block for details. - security
Group string[]Ids - A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.
- snapshot
Arns string[]To Restores - The list of ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis only.
- snapshot
Retention numberLimit - The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only.
- status string
- The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
- subnet
Ids string[] - A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.
- {[key: string]: string}
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- timeouts
Serverless
Cache Timeouts - user
Group stringId - The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL.
- arn str
- The Amazon Resource Name (ARN) of the serverless cache.
- cache_
usage_ Serverlesslimits Cache Cache Usage Limits Args - Sets 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_ strtime - The daily time that snapshots will be created from the new serverless cache. Only supported for engine types
"redis"
or"valkey"
. Defaults to0
. - description str
- User-provided description for the serverless cache. The default is NULL.
- endpoints
Sequence[Serverless
Cache Endpoint Args] - Represents the information required for client programs to connect to a cache node. See
endpoint
Block for details. - engine str
- Name of the cache engine to be used for this cache cluster. Valid values are
memcached
,redis
orvalkey
. - full_
engine_ strversion - The name and version number of the engine the serverless cache is compatible with.
- kms_
key_ strid - ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.
- major_
engine_ strversion - The version of the cache engine that will be used to create the serverless cache. See Describe Cache Engine Versions in the AWS Documentation for supported versions.
- name str
The Cluster name which serves as a unique identifier to the serverless cache
The following arguments are optional:
- reader_
endpoints Sequence[ServerlessCache Reader Endpoint Args] - Represents the information required for client programs to connect to a cache node. See
reader_endpoint
Block for details. - security_
group_ Sequence[str]ids - A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.
- snapshot_
arns_ Sequence[str]to_ restores - The list of ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis only.
- snapshot_
retention_ intlimit - The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only.
- status str
- The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
- subnet_
ids Sequence[str] - A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.
- Mapping[str, str]
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- timeouts
Serverless
Cache Timeouts Args - user_
group_ strid - The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL.
- arn String
- The Amazon Resource Name (ARN) of the serverless cache.
- cache
Usage Property MapLimits - Sets the cache usage limits for storage and ElastiCache Processing Units for the cache. See
cache_usage_limits
Block for details. - create
Time String - Timestamp of when the serverless cache was created.
- daily
Snapshot StringTime - The daily time that snapshots will be created from the new serverless cache. Only supported for engine types
"redis"
or"valkey"
. Defaults to0
. - description String
- User-provided description for the serverless cache. The default is NULL.
- endpoints List<Property Map>
- Represents the information required for client programs to connect to a cache node. See
endpoint
Block for details. - engine String
- Name of the cache engine to be used for this cache cluster. Valid values are
memcached
,redis
orvalkey
. - full
Engine StringVersion - The name and version number of the engine the serverless cache is compatible with.
- kms
Key StringId - ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.
- major
Engine StringVersion - The version of the cache engine that will be used to create the serverless cache. See Describe Cache Engine Versions in the AWS Documentation for supported versions.
- name String
The Cluster name which serves as a unique identifier to the serverless cache
The following arguments are optional:
- reader
Endpoints List<Property Map> - Represents the information required for client programs to connect to a cache node. See
reader_endpoint
Block for details. - security
Group List<String>Ids - A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.
- snapshot
Arns List<String>To Restores - The list of ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis only.
- snapshot
Retention NumberLimit - The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only.
- status String
- The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
- subnet
Ids List<String> - A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.
- Map<String>
- Map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- timeouts Property Map
- user
Group StringId - The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL.
Supporting Types
ServerlessCacheCacheUsageLimits, ServerlessCacheCacheUsageLimitsArgs
- Data
Storage ServerlessCache Cache Usage Limits Data Storage - The maximum data storage limit in the cache, expressed in Gigabytes. See
data_storage
Block for details. - Ecpu
Per List<ServerlessSeconds Cache Cache Usage Limits Ecpu Per Second> - The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second. See
ecpu_per_second
Block for details.
- Data
Storage ServerlessCache Cache Usage Limits Data Storage - The maximum data storage limit in the cache, expressed in Gigabytes. See
data_storage
Block for details. - Ecpu
Per []ServerlessSeconds Cache Cache Usage Limits Ecpu Per Second - The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second. See
ecpu_per_second
Block for details.
- data
Storage ServerlessCache Cache Usage Limits Data Storage - The maximum data storage limit in the cache, expressed in Gigabytes. See
data_storage
Block for details. - ecpu
Per List<ServerlessSeconds Cache Cache Usage Limits Ecpu Per Second> - The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second. See
ecpu_per_second
Block for details.
- data
Storage ServerlessCache Cache Usage Limits Data Storage - The maximum data storage limit in the cache, expressed in Gigabytes. See
data_storage
Block for details. - ecpu
Per ServerlessSeconds Cache Cache Usage Limits Ecpu Per Second[] - The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second. See
ecpu_per_second
Block for details.
- data_
storage ServerlessCache Cache Usage Limits Data Storage - The maximum data storage limit in the cache, expressed in Gigabytes. See
data_storage
Block for details. - ecpu_
per_ Sequence[Serverlessseconds Cache Cache Usage Limits Ecpu Per Second] - The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second. See
ecpu_per_second
Block for details.
- data
Storage Property Map - The maximum data storage limit in the cache, expressed in Gigabytes. See
data_storage
Block for details. - ecpu
Per List<Property Map>Seconds - The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second. See
ecpu_per_second
Block for details.
ServerlessCacheCacheUsageLimitsDataStorage, ServerlessCacheCacheUsageLimitsDataStorageArgs
ServerlessCacheCacheUsageLimitsEcpuPerSecond, ServerlessCacheCacheUsageLimitsEcpuPerSecondArgs
ServerlessCacheEndpoint, ServerlessCacheEndpointArgs
ServerlessCacheReaderEndpoint, ServerlessCacheReaderEndpointArgs
ServerlessCacheTimeouts, ServerlessCacheTimeoutsArgs
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- Update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- Update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Import
Using pulumi import
, import ElastiCache Serverless Cache using the name
. For example:
$ pulumi import aws:elasticache/serverlessCache:ServerlessCache my_cluster my_cluster
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.