Cluster

memorydb.services.k8s.aws/v1alpha1

Metadata#

Contains all of the attributes of a specific cluster.

Spec#

aclName: string
aclRef: 
  from: 
    name: string
    namespace: 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
    namespace: string
port: integer
securityGroupIDs:
- string
securityGroupRefs:
  from: 
    name: string
    namespace: string
snapshotARNs:
- string
snapshotName: string
snapshotRef: 
  from: 
    name: string
    namespace: string
snapshotRetentionLimit: integer
snapshotWindow: string
snsTopicARN: string
snsTopicRef: 
  from: 
    name: string
    namespace: string
subnetGroupName: string
subnetGroupRef: 
  from: 
    name: string
    namespace: string
tags:
- key: string
  value: string
tlsEnabled: boolean

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