Amazon ElastiCache for Redis (Beta)

This topic gives you reference information about the Amazon ElastiCache for Redis (csb-aws-redis) service. It details the plans, configuration parameters, and binding credentials.

Important

The Amazon ElastiCache for Redis service is currently in beta and is intended for evaluation and test purposes only. Do not use this service in a production environment.

Plans

Tables for cache sizes and plans are below:

Cache Size to AWS Node Type Mapping

cache_size	node type
1	cache.t2.small
2	cache.t3.medium
4	cache.m5.large
8	cache.m5.xlarge
16	cache.r4.xlarge
32	cache.r4.2xlarge
64	cache.r4.4xlarge
128	cache.r4.8xlarge
256	cache.r5.12xlarge

Plans

The default plans for Amazon ElastiCache for Redis are in the table below:

Plan	Cache Size	AWS Cache Node Type	HA
small	minimum 1 GB	cache.t2.small	no
medium	minimum 4 GB	cache.m5.large	no
large	minimum 16 GB	cache.r4.xlarge	no
small-ha	minimum 1 GB	cache.t2.small	yes
medium-ha	minimum 4 GB	cache.m5.large	yes
large-ha	minimum 16 GB	cache.r4.xlarge	yes

Plan Configuration Parameters

When configuring Cloud Service Broker for AWS you can add additional plans. For how to configure plans, see Configure Services with Cloud Service Broker for AWS.

The following table lists parameters that can only be configured for additional plans:

Parameter Name	Values	Default	Required
name	The plan name.	n/a	Yes
id	A unique GUID.	n/a	Yes
description	Description of the new plan.	n/a	Yes
display_name	Name to use when displaying the plan in marketplace.	n/a	No
free	When false, service instances of this service plan have a cost.	true	No
bindable	Specifies whether service instances of the service plan can bind to applications.	true	No
plan_updateable	Whether the plan supports upgrading, downgrading, or sidegrading to another version.	true	No
cache_size	Cache size in GB. 2–256, multiples of 2.	n/a	Yes
redis_version	The version for the Redis instance. It can be any AWS-supported Redis version.	n/a	Yes

You can also add any of the parameters listed in the Configuration Parameters section to your plan.

Note

If you set a parameter at plan level, developers cannot change the value when creating or updating service instances.

Configuration Parameters

You can provision a service by running:

cf create-service csb-aws-redis PLAN-NAME SERVICE-INSTANCE-NAME -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}

You can update the configuration parameters for a service instance by running:

cf update-service SERVICE-INSTANCE -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'

The following table lists the parameters that you can configure, by using the -c flag, when provisioning or updating a csb-aws-redis service. The Operation column displays whether a parameter is supported for both provision and update, or for provision only:

Parameter Name	Type	Description	Default	Operation
instance_name	String	The name of the AWS instance to create	csbINSTANCE-ID	provision
region	String	The AWS region to deploy the service in. For more information about available regions, see the AWS documentation.	us-west-2	provision
node_type	String	Specifying the node type overrides the `cache-size` conversion to node type that is described in the Cache Size to AWS Node Type Mapping table in the Plans for Amazon ElastiCache section above. For more information about node types and pricing, see the AWS documentation.	n/a	provision and update
node_count	Integer	Number of nodes (primary and replicas) in the cluster	2	provision and update
aws_vpc_id	String	The Virtual Private Cloud (VPC) to connect the instance to	The default VPC	provision and update
elasticache_subnet_group	String	Pre-existing AWS Elasticache subnet group to use	_n/a_	provision and update
elasticache_vpc_security_group_ids	String	Comma-delimited list of security group IDs for the instance	_n/a_	provision and update
aws_access_key_id	String	The AWS Access Key to use for an instance	The value the operator entered for AWS Access Key in Ops Manager	provision and update
aws_secret_access_key	String	The corresponding secret for the AWS Access Key to use for an instance	The value the operator entered for AWS Secret Access Key in Ops Manager	provision and update

Binding

You can bind a service by running:

cf bind-service APP-NAME SERVICE-INSTANCE --binding-name BINDING-NAME

Binding Credentials

The format for binding credentials for Redis is as follows:

{
    "name" : "REDIS-CLUSTER-NAME",
    "host" : "REDIS-SERVER-HOSTNAME",
    "password" : "AUTHENTICATION-PASSWORD",
    "tls_port" : "REDIS-TLS-PORT"
}