A ReplicationGroup is a managed resource that represents an AWS ElastiCache Replication Group.
Type
CRD
Group
cache.aws.crossplane.io
Version
v1beta1
apiVersion: cache.aws.crossplane.io/v1beta1
kind: ReplicationGroup
A ReplicationGroupSpec defines the desired state of a ReplicationGroup.
ReplicationGroupParameters define the desired state of an AWS ElastiCache Replication Group. Most fields map directly to an AWS ReplicationGroup: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateReplicationGroup.html#API_CreateReplicationGroup_RequestParameters
CacheSecurityGroupNameRefs are references to SecurityGroups used to set the CacheSecurityGroupNames.
Policies for referencing.
CacheSecurityGroupNameSelector selects references to SecurityGroups.
Policies for selection.
CacheSecurityGroupNames specifies a list of cache security group names to associate with this replication group. Only for EC2-Classic mode.
CacheSubnetGroupNameRef is a reference to a Subnet Group used to set the CacheSubnetGroupName.
Policies for referencing.
DeprecatedCacheSubnetGroupNameRef is a reference to a Subnet Group used to set the CacheSubnetGroupName.
Deprecated: Use CacheSubnetGroupNameRef. This field exists because we introduced it with the JSON tag cacheSubnetGroupNameRefs (plural) when it should have been cacheSubnetGroupNameRef (singular). This is a bug that we need to avoid a breaking change to this v1beta1 API.
Policies for referencing.
CacheSubnetGroupNameSelector selects a reference to a CacheSubnetGroup.
Policies for selection.
NodeGroupConfigurationSpec specifies a list of node group (shard) configuration options.
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, 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.
ReplicaAvailabilityZones specifies a list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.
NotificationTopicARNRef references an SNS Topic to retrieve its NotificationTopicARN
Policies for referencing.
NotificationTopicARNSelector selects a reference to an SNS Topic to retrieve its NotificationTopicARN
Policies for selection.
PreferredCacheClusterAZs specifies 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 NodeGroupConfigurationSpec 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.
SecurityGroupIDRefs are references to SecurityGroups used to set the SecurityGroupIDs.
Policies for referencing.
SecurityGroupIDSelector selects references to SecurityGroups used to set the SecurityGroupIDs.
Policies for selection.
SecurityGroupIDs specifies 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 VPC.
SnapshotARNs specifies 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 NodeGroupConfigurationSpec regardless of the number of ARNs specified here.
THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.
Policies for referencing.
PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.
WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.
A ReplicationGroupStatus defines the observed state of a ReplicationGroup.
ReplicationGroupObservation contains the observation of the status of the given ReplicationGroup.
MemberClusters is the list of names of all the cache clusters that are part of this replication group.
NodeGroups is 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).
NodeGroupMembers is a list containing information about individual nodes within the node group (shard).
PendingModifiedValues is a group of settings to be applied to the replication group, either immediately or during the next maintenance window.
Resharding is the status of an online resharding operation.
Represents the progress of an online resharding operation.
Conditions of the resource.
test-cache
apiVersion: cache.aws.crossplane.io/v1beta1
kind: ReplicationGroup
metadata:
labels:
example: "true"
name: test-cache
spec:
forProvider:
applyModificationsImmediately: true
automaticFailoverEnabled: true
cacheNodeType: cache.t3.medium
cacheParameterGroupName: default.redis6.x
cacheSubnetGroupNameRef:
name: sample-cache-subnet-group
engine: redis
engineVersion: "6.2"
numCacheClusters: 3
port: 6379
region: us-east-1
replicationGroupDescription: An example replication group
providerConfigRef:
name: example
writeConnectionSecretToRef:
name: replicationgroup
namespace: crossplane-system