Cluster
memorydb.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | memorydb-controller/apis/v1alpha1#Cluster |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Cluster |
| ListKind | ClusterList |
| Plural | clusters |
| Singular | cluster |
Contains all of the attributes of a specific cluster.
Spec
aclName: string
aclRef:
from:
name: string
autoMinorVersionUpgrade: boolean
description: string
engineVersion: string
kmsKeyID: string
maintenanceWindow: string
name: string
nodeType: string
numReplicasPerShard: integer
numShards: integer
parameterGroupName: string
parameterGroupRef:
from:
name: string
port: integer
securityGroupIDs:
- string
securityGroupRefs:
from:
name: string
snapshotARNs:
- string
snapshotName: string
snapshotRef:
from:
name: string
snapshotRetentionLimit: integer
snapshotWindow: string
snsTopicARN: string
snsTopicRef:
from:
name: string
subnetGroupName: string
subnetGroupRef:
from:
name: string
tags:
- key: string
value: string
tlsEnabled: boolean
| Field | Description |
|---|---|
| aclName Optional | string The name of the Access Control List to associate with the cluster. |
| aclRef 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 |
| aclRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| aclRef.from.name Optional | string |
| autoMinorVersionUpgrade Optional | boolean When set to true, the cluster will automatically receive minor engine version upgrades after launch. |
| description Optional | string An optional description of the cluster. |
| engineVersion Optional | string The version number of the Redis engine to be used for the cluster. |
| kmsKeyID Optional | string The ID of the KMS key used to encrypt the cluster. |
| maintenanceWindow Optional | string Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. |
| name Required | string The name of the cluster. This value must be unique as it also serves as the cluster identifier. |
| nodeType Required | string The compute and memory capacity of the nodes in the cluster. |
| numReplicasPerShard Optional | integer The number of replicas to apply to each shard. The default value is 1. The maximum is 5. |
| numShards Optional | integer The number of shards the cluster will contain. The default value is 1. |
| parameterGroupName Optional | string The name of the parameter group associated with the cluster. |
| parameterGroupRef 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 |
| parameterGroupRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| parameterGroupRef.from.name Optional | string |
| port Optional | integer The port number on which each of the nodes accepts connections. |
| securityGroupIDs Optional | array A list of security group names to associate with this cluster. |
| 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 RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas. |
| snapshotARNs.[] Required | string |
| snapshotRef 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 |
| snapshotRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| snapshotRef.from.name Optional | string |
| snapshotRetentionLimit Optional | integer The number of days for which MemoryDB 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. |
| snapshotWindow Optional | string The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range. |
| snsTopicARN Optional | string The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. |
| snsTopicRef 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 |
| snsTopicRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| snsTopicRef.from.name Optional | string |
| subnetGroupName Optional | string The name of the subnet group to be used for the cluster. |
| subnetGroupRef 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 |
| subnetGroupRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| subnetGroupRef.from.name Optional | string |
| 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.[] Required | object A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources (https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging-resources.html) |
| tags.[].value Optional | string |
| tlsEnabled Optional | boolean A flag to enable in-transit encryption on the cluster. |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
allowedScaleDownNodeTypes:
- string
allowedScaleUpNodeTypes:
- string
availabilityMode: string
clusterEndpoint:
address: string
port: integer
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
enginePatchVersion: string
events:
- date: string
message: string
sourceName: string
sourceType: string
numberOfShards: integer
parameterGroupStatus: string
pendingUpdates:
acls:
aclToApply: string
resharding:
slotMigration:
progressPercentage: number
serviceUpdates:
- serviceUpdateName: string
status: string
securityGroups:
- securityGroupID: string
status: string
shards:
- name: string
nodes:
- availabilityZone: string
createTime: string
endpoint:
address: string
port: integer
name: string
status: string
numberOfNodes: integer
slots: string
status: string
snsTopicStatus: string
status: string
| Field | Description |
|---|---|
| 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. |
| allowedScaleDownNodeTypes Optional | array A list node types which you can use to scale down your cluster. |
| allowedScaleDownNodeTypes.[] Required | string |
| allowedScaleUpNodeTypes.[] Required | string |
| clusterEndpoint Optional | object The cluster’s configuration endpoint |
| clusterEndpoint.address Optional | string |
| clusterEndpoint.port Optional | integer |
| 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 |
| enginePatchVersion Optional | string The Redis engine patch version used by the cluster |
| 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 or adding or removing a node. |
| events.[].message Optional | string |
| events.[].sourceName Optional | string |
| events.[].sourceType Optional | string |
| numberOfShards Optional | integer The number of shards in the cluster |
| parameterGroupStatus Optional | string The status of the parameter group used by the cluster, for example ‘active’ or ‘applying’. |
| pendingUpdates Optional | object A group of settings that are currently being applied. |
| pendingUpdates.acls Optional | object The status of the ACL update |
| pendingUpdates.acls.aclToApply Optional | string |
| pendingUpdates.resharding Optional | object The status of the online resharding |
| pendingUpdates.resharding.slotMigration Optional | object Represents the progress of an online resharding operation. |
| pendingUpdates.resharding.slotMigration.progressPercentage Optional | number |
| pendingUpdates.serviceUpdates Optional | array |
| pendingUpdates.serviceUpdates.[] Required | object Update action that has yet to be processed for the corresponding apply/stop request |
| pendingUpdates.serviceUpdates.[].status Optional | string |
| securityGroups Optional | array A list of security groups used by the cluster |
| securityGroups.[] Required | object Represents a single security group and its status. |
| securityGroups.[].status Optional | string |
| shards Optional | array A list of shards that are members of the cluster. |
| shards.[] Required | object Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes. |
| shards.[].nodes Optional | array |
| shards.[].nodes.[] Required | object Represents an individual node within a cluster. Each node runs its own instance of the cluster’s protocol-compliant caching software. |
| shards.[].nodes.[].createTime Optional | string |
| shards.[].nodes.[].endpoint Optional | object Represents the information required for client programs to connect to the cluster and its nodes. |
| shards.[].nodes.[].endpoint.address Optional | string |
| shards.[].nodes.[].endpoint.port Optional | integer |
| shards.[].nodes.[].name Optional | string |
| shards.[].nodes.[].status Optional | string |
| shards.[].numberOfNodes Optional | integer |
| shards.[].slots Optional | string |
| shards.[].status Optional | string |
| snsTopicStatus Optional | string The SNS topic must be in Active status to receive notifications |
| status Optional | string The status of the cluster. For example, Available, Updating, Creating. |