AWS Fundamentals Logo
AWS Fundamentals
AWS::ElastiCache::ReplicationGroup

ElastiCache ReplicationGroup

Resource type definition for AWS::ElastiCache::ReplicationGroup

Properties

39 configurable properties. 1 required. Click a row to see details.

Filter:
PropertyTypeFlags
ReplicationGroupDescription
string
Required
AtRestEncryptionEnabled
boolean
Create-only
AuthToken
string
Write-only
AutomaticFailoverEnabled
boolean
AutoMinorVersionUpgrade
boolean
CacheNodeType
string
CacheParameterGroupName
string
Write-only
CacheSecurityGroupNames
Array<string>
Write-onlyDeprecated
CacheSubnetGroupName
string
Create-onlyWrite-only
ClusterMode
string
DataTieringEnabled
boolean
Create-only
Engine
string
EngineVersion
string
Write-only
GlobalReplicationGroupId
string
Create-only
IpDiscovery
string
KmsKeyId
string
Create-onlyWrite-only
LogDeliveryConfigurations
Array<LogDeliveryConfigurationRequest>
MultiAZEnabled
boolean
NetworkType
string
Create-only
NodeGroupConfiguration
Array<NodeGroupConfiguration>
Write-only
NotificationTopicArn
string
Write-only
NumCacheClusters
integer
NumNodeGroups
integer
Write-only
Port
integer
Create-only
PreferredCacheClusterAZs
Array<string>
Create-onlyWrite-only
PreferredMaintenanceWindow
string
Write-only
PrimaryClusterId
string
Write-only
ReplicasPerNodeGroup
integer
Create-onlyWrite-only
ReplicationGroupId
string
Create-only
SecurityGroupIds
Array<string>
Write-only
SnapshotArns
Array<string>
Create-onlyWrite-only
SnapshotName
string
Create-onlyWrite-only
SnapshotRetentionLimit
integer
SnapshottingClusterId
string
SnapshotWindow
string
Tags
Array<Tag>
TransitEncryptionEnabled
boolean
TransitEncryptionMode
string
UserGroupIds
Array<string>

Return Values

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

AttributeTypeDescription
ConfigurationEndPointEndpointThe configuration details of the replication group.
PrimaryEndPointEndpointThe primary endpoint configuration
ReadEndPointobject-
ReaderEndPointEndpointThe endpoint of the reader node in the replication group.

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::ReplicationGroup

Resources:
  MyResource:
    Type: AWS::ElastiCache::ReplicationGroup
    Properties:
      ReplicationGroupDescription: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

create

elasticache:CreateReplicationGroupelasticache:DescribeReplicationGroupselasticache:ModifyReplicationGroupelasticache:AddTagsToResourcelogs:CreateLogStreamlogs:PutLogEventslogs:CreateLogDeliverylogs:UpdateLogDeliverylogs:DeleteLogDeliverylogs:GetLogDeliverylogs:ListLogDeliveriesfirehose:PutRecordfirehose:PutRecordBatchfirehose:TagDeliveryStreamiam:CreateServiceLinkedRolekms:Decryptkms:Encryptkms:GenerateDataKeykms:CreateGrantkms:DescribeKeys3:GetObject

read

elasticache:DescribeReplicationGroupselasticache:ListTagsForResource

update

elasticache:ModifyReplicationGroupelasticache:ModifyReplicationGroupShardConfigurationelasticache:DescribeReplicationGroupselasticache:ListTagsForResourceelasticache:AddTagsToResourceelasticache:RemoveTagsFromResourceelasticache:CreateCacheClusterelasticache:DeleteCacheClusterelasticache:DescribeCacheClusterslogs:CreateLogStreamlogs:PutLogEventslogs:CreateLogDeliverylogs:UpdateLogDeliverylogs:DeleteLogDeliverylogs:GetLogDeliverylogs:ListLogDeliveriesfirehose:PutRecordfirehose:PutRecordBatchs3:GetObjectfirehose:TagDeliveryStreamkms:Decryptkms:Encryptkms:GenerateDataKeykms:CreateGrantkms:DescribeKeyiam:CreateServiceLinkedRole

delete

elasticache:DeleteReplicationGroupelasticache:DescribeReplicationGroupselasticache:CreateSnapshot

list

elasticache:DescribeReplicationGroups

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
Properties43
Required1
TaggingSupported
Primary IDReplicationGroupId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

AtRestEncryptionEnabledCacheSubnetGroupNameDataTieringEnabledGlobalReplicationGroupIdKmsKeyIdNetworkTypePortPreferredCacheClusterAZsReplicasPerNodeGroupReplicationGroupIdSnapshotArnsSnapshotName

Related Resources

External Links