AWS Fundamentals Logo
AWS Fundamentals
AWS::ElastiCache::CacheCluster

ElastiCache CacheCluster

Resource type definition for AWS::ElastiCache::CacheCluster

Properties

25 configurable properties. 3 required. Click a row to see details.

Filter:
PropertyTypeFlags
CacheNodeType
string
Required
Engine
string
RequiredCreate-only
NumCacheNodes
integer
Required
AutoMinorVersionUpgrade
boolean
AZMode
string
CacheParameterGroupName
string
CacheSecurityGroupNames
Array<string>
Write-onlyDeprecated
CacheSubnetGroupName
string
Create-only
ClusterName
string
Create-only
EngineVersion
string
IpDiscovery
string
LogDeliveryConfigurations
Array<LogDeliveryConfigurationRequest>
NetworkType
string
Create-only
NotificationTopicArn
string
Port
integer
Create-only
PreferredAvailabilityZone
string
Write-only
PreferredAvailabilityZones
Array<string>
PreferredMaintenanceWindow
string
SnapshotArns
Array<string>
Create-onlyWrite-only
SnapshotName
string
Create-onlyWrite-only
SnapshotRetentionLimit
integer
SnapshotWindow
string
Tags
Array<Tag>
TransitEncryptionEnabled
boolean
VpcSecurityGroupIds
Array<string>

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
ConfigurationEndpointEndpointSpecifies the ConfigurationEndpoint address and port
RedisEndpointEndpointSpecifies the RedisEndPoint address and port

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ElastiCache::CacheCluster

Resources:
  MyResource:
    Type: AWS::ElastiCache::CacheCluster
    Properties:
      CacheNodeType: "value"
      NumCacheNodes: 1
      Engine: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

elasticache:DescribeCacheClusterselasticache:CreateCacheClusterelasticache:AddTagsToResourceelasticache:DeleteCacheClusters3:GetObjectlogs:CreateLogDeliverylogs:GetLogDeliverylogs:ListLogDeliverieslogs:UpdateLogDeliverylogs:DeleteLogDeliverylogs:PutResourcePolicylogs:DescribeResourcePolicieslogs:DescribeLogGroupslogs:CreateLogStreamfirehose:TagDeliveryStreamiam:CreateServiceLinkedRole

read

elasticache:ListTagsForResourceelasticache:DescribeCacheClusterslogs:GetLogDeliverylogs:DescribeLogGroups

update

elasticache:DescribeCacheClusterselasticache:ModifyCacheClusterelasticache:AddTagsToResourceelasticache:RemoveTagsFromResourceelasticache:RebootCacheClusterlogs:CreateLogDeliverylogs:GetLogDeliverylogs:ListLogDeliverieslogs:UpdateLogDeliverylogs:DeleteLogDeliverylogs:PutResourcePolicylogs:DescribeResourcePolicieslogs:DescribeLogGroupslogs:CreateLogStreams3:GetObjectfirehose:TagDeliveryStreamiam:CreateServiceLinkedRole

delete

elasticache:DescribeCacheClusterselasticache:DeleteCacheClusterelasticache:CreateSnapshot

list

elasticache:DescribeCacheClusters

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceElastiCache
Properties27
Required3
TaggingSupported
Primary IDClusterName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

PortSnapshotArnsSnapshotNameCacheSubnetGroupNameClusterNameEngineNetworkType

Related Resources

External Links