AWS::ElastiCache::ReplicationGroup

ElastiCache ReplicationGroup

Resource Type definition for AWS::ElastiCache::ReplicationGroup

Properties

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

Filter:

Property	Type	Flags
`ReplicationGroupDescription`	`string`	Required
`AtRestEncryptionEnabled`	`boolean`	Create-only
`AuthToken`	`string`
`AutomaticFailoverEnabled`	`boolean`
`AutoMinorVersionUpgrade`	`boolean`
`CacheNodeType`	`string`
`CacheParameterGroupName`	`string`
`CacheSecurityGroupNames`	`Array<string>`
`CacheSubnetGroupName`	`string`	Create-only
`ClusterMode`	`string`
`ConfigurationEndPointAddress`	`string`
`ConfigurationEndPointPort`	`string`
`DataTieringEnabled`	`boolean`	Create-only
`Engine`	`string`
`EngineVersion`	`string`
`GlobalReplicationGroupId`	`string`	Create-only
`IpDiscovery`	`string`
`KmsKeyId`	`string`	Create-only
`LogDeliveryConfigurations`	`Array<LogDeliveryConfigurationRequest>`
`MultiAZEnabled`	`boolean`
`NetworkType`	`string`	Create-only
`NodeGroupConfiguration`	`Array<NodeGroupConfiguration>`
`NotificationTopicArn`	`string`
`NumCacheClusters`	`integer`
`NumNodeGroups`	`integer`
`Port`	`integer`	Create-only
`PreferredCacheClusterAZs`	`Array<string>`	Create-only
`PreferredMaintenanceWindow`	`string`
`PrimaryClusterId`	`string`
`PrimaryEndPointAddress`	`string`
`PrimaryEndPointPort`	`string`
`ReadEndPointAddresses`	`string`
`ReadEndPointAddressesList`	`Array<string>`
`ReadEndPointPorts`	`string`
`ReadEndPointPortsList`	`Array<string>`
`ReaderEndPointAddress`	`string`
`ReaderEndPointPort`	`string`
`ReplicasPerNodeGroup`	`integer`	Create-only
`SecurityGroupIds`	`Array<string>`
`SnapshotArns`	`Array<string>`	Create-only
`SnapshotName`	`string`	Create-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.

Attribute	Type	Description
`ReplicationGroupId`	`string`	-

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

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

Properties49

Required1

TaggingNot supported

Primary IDReplicationGroupId

Immutable After Creation

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

KmsKeyIdPortSnapshotArnsSnapshotNameCacheSubnetGroupNameNetworkTypeDataTieringEnabledAtRestEncryptionEnabledReplicationGroupIdGlobalReplicationGroupIdReplicasPerNodeGroupPreferredCacheClusterAZs

Related Resources

External Links

AWS Documentation