ReplicationGroup

elasticache.services.k8s.aws/v1alpha1

TypeLink
GoDocelasticache-controller/apis/v1alpha1#ReplicationGroup

Metadata

PropertyValue
ScopeNamespaced
KindReplicationGroup
ListKindReplicationGroupList
Pluralreplicationgroups
Singularreplicationgroup

Contains all of the attributes of a specific Redis replication group.

Spec

atRestEncryptionEnabled: boolean
authToken: 
  key: string
  name: string
  namespace: string
automaticFailoverEnabled: boolean
cacheNodeType: string
cacheParameterGroupName: string
cacheParameterGroupRef: 
  from: 
    name: string
cacheSecurityGroupNames:
- string
cacheSubnetGroupName: string
cacheSubnetGroupRef: 
  from: 
    name: string
dataTieringEnabled: boolean
description: string
engine: string
engineVersion: string
kmsKeyID: string
logDeliveryConfigurations:
  destinationDetails: 
    cloudWatchLogsDetails: 
      logGroup: string
    kinesisFirehoseDetails: 
      deliveryStream: string
  destinationType: string
  enabled: boolean
  logFormat: string
  logType: string
multiAZEnabled: boolean
nodeGroupConfiguration:
- nodeGroupID: string
  primaryAvailabilityZone: string
  primaryOutpostARN: string
  replicaAvailabilityZones:
  - string
  replicaCount: integer
  replicaOutpostARNs:
  - string
  slots: string
notificationTopicARN: string
numNodeGroups: integer
port: integer
preferredCacheClusterAZs:
- string
preferredMaintenanceWindow: string
primaryClusterID: string
replicasPerNodeGroup: integer
replicationGroupID: string
securityGroupIDs:
- string
securityGroupRefs:
  from: 
    name: string
snapshotARNs:
- string
snapshotName: string
snapshotRetentionLimit: integer
snapshotWindow: string
tags:
- key: string
  value: string
transitEncryptionEnabled: boolean
userGroupIDs:
- string
FieldDescription
atRestEncryptionEnabled
Optional		boolean
A flag that enables encryption at rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
authToken
Optional		object
Reserved parameter. The password used to access a password protected server.
AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.
For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.
Password constraints:
* Must be only printable ASCII characters.
* Must be at least 16 characters and no more than 128 characters in length.
* The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
For more information, see AUTH password (http://redis.io/commands/AUTH) at http://redis.io/commands/AUTH.
authToken.key
Required		string
Key is the key within the secret
authToken.name
Optional		string
name is unique within a namespace to reference a secret resource.
authToken.namespace
Optional		string
namespace defines the space within which the secret name must be unique.
automaticFailoverEnabled
Optional		boolean
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.
Default: false
cacheNodeType
Optional		string
The compute and memory capacity of the nodes in the node group (shard).
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
* General purpose: Current generation: M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
* Compute optimized: Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) C1 node types: cache.c1.xlarge
* Memory optimized with data tiering: Current generation: R6gd node types (available only for Redis engine version 6.2 onward). cache.r6gd.xlarge, cache.r6gd.2xlarge, cache.r6gd.4xlarge, cache.r6gd.8xlarge, cache.r6gd.12xlarge, cache.r6gd.16xlarge
* Memory optimized: Current generation: R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
* All current generation instance types are created in Amazon VPC by default.
* Redis append-only files (AOF) are not supported for T1 or T2 instances.
* Redis Multi-AZ with automatic failover is not supported on T1 instances.
* Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
cacheParameterGroupName
Optional		string
The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.
If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.
* To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.
* To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.
cacheParameterGroupRef
Optional		object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef:
from: name: my-api
cacheParameterGroupRef.from
Optional		object
AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)
cacheParameterGroupRef.from.name
Optional		string
cacheSecurityGroupNames
Optional		array
A list of cache security group names to associate with this replication group.
cacheSecurityGroupNames.[]
Required		string
cacheSubnetGroupRef
Optional		object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef:
from: name: my-api
cacheSubnetGroupRef.from
Optional		object
AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)
cacheSubnetGroupRef.from.name
Optional		string
dataTieringEnabled
Optional		boolean
Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html).
description
Required		string
A user-created description for the replication group.
engine
Optional		string
The name of the cache engine to be used for the clusters in this replication group. Must be Redis.
engineVersion
Optional		string
The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
kmsKeyID
Optional		string
The ID of the KMS key used to encrypt the disk in the cluster.
logDeliveryConfigurations
Optional		array
Specifies the destination, format and type of the logs.
logDeliveryConfigurations.[]
Required		object
Specifies the destination, format and type of the logs.
logDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails
Optional		object
The configuration details of the CloudWatch Logs destination.
logDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails.logGroup
Optional		string
logDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails
Optional		object
The configuration details of the Kinesis Data Firehose destination.
logDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails.deliveryStream
Optional		string
logDeliveryConfigurations.[].destinationType
Optional		string
logDeliveryConfigurations.[].enabled
Optional		boolean
logDeliveryConfigurations.[].logFormat
Optional		string
logDeliveryConfigurations.[].logType
Optional		string
multiAZEnabled
Optional		boolean
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html).
nodeGroupConfiguration
Optional		array
A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.
If you’re creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.
nodeGroupConfiguration.[]
Required		object
Node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.
nodeGroupConfiguration.[].primaryAvailabilityZone
Optional		string
nodeGroupConfiguration.[].primaryOutpostARN
Optional		string
nodeGroupConfiguration.[].replicaAvailabilityZones
Optional		array
nodeGroupConfiguration.[].replicaAvailabilityZones.[]
Required		string
nodeGroupConfiguration.[].replicaOutpostARNs
Optional		array
nodeGroupConfiguration.[].replicaOutpostARNs.[]
Required		string
notificationTopicARN
Optional		string
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
The Amazon SNS topic owner must be the same as the cluster owner.
numNodeGroups
Optional		integer
An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1.
Default: 1
port
Optional		integer
The port number on which each member of the replication group accepts connections.
preferredCacheClusterAZs
Optional		array
A list of EC2 Availability Zones in which the replication group’s clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.
This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.
If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.
The number of Availability Zones listed must equal the value of NumCacheClusters.
Default: system chosen Availability Zones.
preferredCacheClusterAZs.[]
Required		string
primaryClusterID
Optional		string
The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.
This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.
replicasPerNodeGroup
Optional		integer
An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
replicationGroupID
Required		string
The replication group identifier. This parameter is stored as a lowercase string.
Constraints:
* A name must contain from 1 to 40 alphanumeric characters or hyphens.
* The first character must be a letter.
* A name cannot end with a hyphen or contain two consecutive hyphens.
securityGroupIDs
Optional		array
One or more Amazon VPC security groups associated with this replication group.
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
securityGroupIDs.[]
Required		string
securityGroupRefs.[]
Required		object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef:
from: name: my-api
securityGroupRefs.[].from.name
Optional		string
snapshotARNs
Optional		array
A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
snapshotARNs.[]
Required		string
snapshotRetentionLimit
Optional		integer
The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
Default: 0 (i.e., automatic backups are disabled for this cluster).
snapshotWindow
Optional		string
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
tags
Optional		array
A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue. Tags on replication groups will be replicated to all nodes.
tags.[]
Required		object
A tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.
tags.[].value
Optional		string
transitEncryptionEnabled
Optional		boolean
A flag that enables in-transit encryption when set to true.
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC.
If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.
userGroupIDs
Optional		array
The user group to associate with the replication group.
userGroupIDs.[]
Required		string

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
allowedScaleDownModifications:
- string
allowedScaleUpModifications:
- string
authTokenEnabled: boolean
authTokenLastModifiedDate: string
autoMinorVersionUpgrade: boolean
automaticFailover: string
clusterEnabled: boolean
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
configurationEndpoint: 
  address: string
  port: integer
dataTiering: string
events:
- date: string
  message: string
  sourceIdentifier: string
  sourceType: string
globalReplicationGroupInfo: 
  globalReplicationGroupID: string
  globalReplicationGroupMemberRole: string
logDeliveryConfigurations:
  destinationDetails: 
    cloudWatchLogsDetails: 
      logGroup: string
    kinesisFirehoseDetails: 
      deliveryStream: string
  destinationType: string
  logFormat: string
  logType: string
  message: string
  status: string
memberClusters:
- string
memberClustersOutpostARNs:
- string
multiAZ: string
nodeGroups:
- nodeGroupID: string
  nodeGroupMembers:
  - cacheClusterID: string
    cacheNodeID: string
    currentRole: string
    preferredAvailabilityZone: string
    preferredOutpostARN: string
    readEndpoint: 
      address: string
      port: integer
  primaryEndpoint: 
    address: string
    port: integer
  readerEndpoint: 
    address: string
    port: integer
  slots: string
  status: string
pendingModifiedValues: 
  authTokenStatus: string
  automaticFailoverStatus: string
  logDeliveryConfigurations:
    destinationDetails: 
      cloudWatchLogsDetails: 
        logGroup: string
      kinesisFirehoseDetails: 
        deliveryStream: string
    destinationType: string
    logFormat: string
    logType: string
  primaryClusterID: string
  resharding: 
    slotMigration: 
      progressPercentage: number
  userGroups: 
    userGroupIDsToAdd:
    - string
    userGroupIDsToRemove:
    - string
replicationGroupCreateTime: string
snapshottingClusterID: string
status: string
FieldDescription
ackResourceMetadata
Optional		object
All CRs managed by ACK have a common Status.ACKResourceMetadata member that is used to contain resource sync state, account ownership, constructed ARN for the resource
ackResourceMetadata.arn
Optional		string
ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID
Required		string
OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.
ackResourceMetadata.region
Required		string
Region is the AWS region in which the resource exists or will exist.
allowedScaleDownModifications
Optional		array
A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. When scaling down a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.
allowedScaleDownModifications.[]
Required		string
allowedScaleUpModifications.[]
Required		string
authTokenLastModifiedDate
Optional		string
The date the auth token was last modified
autoMinorVersionUpgrade
Optional		boolean
If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
automaticFailover
Optional		string
Indicates the status of automatic failover for this Redis replication group.
clusterEnabled
Optional		boolean
A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).
Valid values: true
conditions
Optional		array
All CRS managed by ACK have a common Status.Conditions member that contains a collection of ackv1alpha1.Condition objects that describe the various terminal states of the CR and its backend AWS service API resource
conditions.[]
Required		object
Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource
conditions.[].message
Optional		string
A human readable message indicating details about the transition.
conditions.[].reason
Optional		string
The reason for the condition’s last transition.
conditions.[].status
Optional		string
Status of the condition, one of True, False, Unknown.
conditions.[].type
Optional		string
Type is the type of the Condition
configurationEndpoint
Optional		object
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
configurationEndpoint.address
Optional		string
configurationEndpoint.port
Optional		integer
dataTiering
Optional		string
Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html).
events
Optional		array
A list of events. Each element in the list contains detailed information about one event.
events.[]
Required		object
Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.
events.[].message
Optional		string
events.[].sourceIdentifier
Optional		string
events.[].sourceType
Optional		string
globalReplicationGroupInfo
Optional		object
The name of the Global datastore and role of this replication group in the Global datastore.
globalReplicationGroupInfo.globalReplicationGroupID
Optional		string
globalReplicationGroupInfo.globalReplicationGroupMemberRole
Optional		string
logDeliveryConfigurations
Optional		array
Returns the destination, format and type of the logs.
logDeliveryConfigurations.[]
Required		object
Returns the destination, format and type of the logs.
logDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails
Optional		object
The configuration details of the CloudWatch Logs destination.
logDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails.logGroup
Optional		string
logDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails
Optional		object
The configuration details of the Kinesis Data Firehose destination.
logDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails.deliveryStream
Optional		string
logDeliveryConfigurations.[].destinationType
Optional		string
logDeliveryConfigurations.[].logFormat
Optional		string
logDeliveryConfigurations.[].logType
Optional		string
logDeliveryConfigurations.[].message
Optional		string
logDeliveryConfigurations.[].status
Optional		string
memberClusters
Optional		array
The names of all the cache clusters that are part of this replication group.
memberClusters.[]
Required		string
memberClustersOutpostARNs.[]
Required		string
nodeGroups
Optional		array
A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).
nodeGroups.[]
Required		object
Represents a collection of cache nodes in a replication group. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
nodeGroups.[].nodeGroupMembers
Optional		array
nodeGroups.[].nodeGroupMembers.[]
Required		object
Represents a single node within a node group (shard).
nodeGroups.[].nodeGroupMembers.[].cacheNodeID
Optional		string
nodeGroups.[].nodeGroupMembers.[].currentRole
Optional		string
nodeGroups.[].nodeGroupMembers.[].preferredAvailabilityZone
Optional		string
nodeGroups.[].nodeGroupMembers.[].preferredOutpostARN
Optional		string
nodeGroups.[].nodeGroupMembers.[].readEndpoint
Optional		object
Represents the information required for client programs to connect to a cache node.
nodeGroups.[].nodeGroupMembers.[].readEndpoint.address
Optional		string
nodeGroups.[].nodeGroupMembers.[].readEndpoint.port
Optional		integer
nodeGroups.[].primaryEndpoint
Optional		object
Represents the information required for client programs to connect to a cache node.
nodeGroups.[].primaryEndpoint.address
Optional		string
nodeGroups.[].primaryEndpoint.port
Optional		integer
nodeGroups.[].readerEndpoint
Optional		object
Represents the information required for client programs to connect to a cache node.
nodeGroups.[].readerEndpoint.address
Optional		string
nodeGroups.[].readerEndpoint.port
Optional		integer
nodeGroups.[].slots
Optional		string
nodeGroups.[].status
Optional		string
pendingModifiedValues
Optional		object
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
pendingModifiedValues.authTokenStatus
Optional		string
pendingModifiedValues.automaticFailoverStatus
Optional		string
pendingModifiedValues.logDeliveryConfigurations
Optional		array
pendingModifiedValues.logDeliveryConfigurations.[]
Required		object
The log delivery configurations being modified
pendingModifiedValues.logDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails
Optional		object
The configuration details of the CloudWatch Logs destination.
pendingModifiedValues.logDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails.logGroup
Optional		string
pendingModifiedValues.logDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails
Optional		object
The configuration details of the Kinesis Data Firehose destination.
pendingModifiedValues.logDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails.deliveryStream
Optional		string
pendingModifiedValues.logDeliveryConfigurations.[].destinationType
Optional		string
pendingModifiedValues.logDeliveryConfigurations.[].logFormat
Optional		string
pendingModifiedValues.logDeliveryConfigurations.[].logType
Optional		string
pendingModifiedValues.primaryClusterID
Optional		string
pendingModifiedValues.resharding
Optional		object
The status of an online resharding operation.
pendingModifiedValues.resharding.slotMigration
Optional		object
Represents the progress of an online resharding operation.
pendingModifiedValues.resharding.slotMigration.progressPercentage
Optional		number
pendingModifiedValues.userGroups
Optional		object
The status of the user group update.
pendingModifiedValues.userGroups.userGroupIDsToAdd
Optional		array
pendingModifiedValues.userGroups.userGroupIDsToAdd.[]
Required		string
pendingModifiedValues.userGroups.userGroupIDsToRemove.[]
Required		string
snapshottingClusterID
Optional		string
The cluster ID that is used as the daily snapshot source for the replication group.
status
Optional		string
The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.