Redis
Reference doc for the `sst.aws.Redis` component.
The Redis
component lets you add a Redis cluster to your app using
Amazon ElastiCache.
Create the cluster
Link to a resource
You can link your cluster to other resources, like a function or your Next.js app.
Once linked, you can connect to it from your function code.
Constructor
Parameters
-
name
string
-
args
RedisArgs
-
opts?
ComponentResourceOptions
RedisArgs
instance?
Type Input
<
string
>
Default “t4g.micro”
The type of instance to use for the nodes of the Redis cluster. Check out the supported instance types.
nodes?
Type Input
<
number
>
Default 1
The number of nodes to use for the Redis cluster.
transform?
Type Object
Transform how this component creates its underlying resources.
transform.cluster?
Type ReplicationGroupArgs
|
(
args
:
ReplicationGroupArgs
,
opts
:
ComponentResourceOptions
,
name
:
string
)
=>
void
Transform the Redis cluster.
transform.subnetGroup?
Type SubnetGroupArgs
|
(
args
:
SubnetGroupArgs
,
opts
:
ComponentResourceOptions
,
name
:
string
)
=>
void
Transform the Redis subnet group.
version?
vpc
Type Vpc
|
Input
<
Object
>
The VPC to use for the Redis cluster.
Create a VPC component.
And pass it in.
Or pass in a custom VPC configuration.
vpc.securityGroups
Type Input
<
Input
<
string
>
[]
>
A list of VPC security group IDs.
vpc.subnets
Type Input
<
Input
<
string
>
[]
>
A list of subnet IDs in the VPC to deploy the Redis cluster in.
Properties
clusterID
Type Output
<
string
>
The ID of the Redis cluster.
host
Type Output
<
string
>
The host to connect to the Redis cluster.
nodes
Type Object
nodes.cluster
Type ReplicationGroup
password
Type Output
<
string
>
The password to connect to the Redis cluster.
port
Type Output
<
number
>
The port to connect to the Redis cluster.
username
Type Output
<
string
>
The username to connect to the Redis cluster.
SDK
Use the SDK in your runtime to interact with your infrastructure.
Links
This is accessible through the Resource
object in the SDK.
-
host
string
The host to connect to the Redis cluster.
-
password
string
The password to connect to the Redis cluster.
-
port
number
The port to connect to the Redis cluster.
-
username
string
The username to connect to the Redis cluster.
Methods
static get
Parameters
The name of the component.name
string
The id of the existing Redis cluster.clusterID
Input
<
string
>
Returns Redis
Reference an existing Redis cluster with the given cluster name. This is useful when you create a Redis cluster in one stage and want to share it in another. It avoids having to create a new Redis cluster in the other stage.
Imagine you create a cluster in the dev
stage. And in your personal stage frank
,
instead of creating a new cluster, you want to share the same cluster from dev
.
Here app-dev-myredis
is the ID of the cluster created in the dev
stage.
You can find this by outputting the cluster ID in the dev
stage.