ReplicationGroup

elasticache.services.k8s.aws/v1alpha1

Metadata#

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

from:
  name: my-api || **securityGroupRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |

| 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
|| snapshotName
Optional | string
The name of a snapshot from which to restore data into the new replication
group. The snapshot status changes to restoring while the new replication
group is being created. | | 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.[].key
Optional | string
| | 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