Snapshot
memorydb.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | memorydb-controller/apis/v1alpha1#Snapshot |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Snapshot |
| ListKind | SnapshotList |
| Plural | snapshots |
| Singular | snapshot |
Represents a copy of an entire cluster as of the time when the snapshot was taken.
Spec
clusterName: string
clusterRef:
from:
name: string
namespace: string
kmsKeyID: string
kmsKeyRef:
from:
name: string
namespace: string
name: string
sourceSnapshotName: string
tags:
- key: string
value: string
| Field | Description |
|---|---|
| clusterName Optional | string The snapshot is created from this cluster. |
| clusterRef 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 |
| clusterRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| clusterRef.from.name Optional | string |
| clusterRef.from.namespace Optional | string |
| kmsKeyID Optional | string The ID of the KMS key used to encrypt the snapshot. |
| kmsKeyRef 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 |
| kmsKeyRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| kmsKeyRef.from.name Optional | string |
| kmsKeyRef.from.namespace Optional | string |
| name Required | string A name for the snapshot being created. |
| sourceSnapshotName Optional | string The name of an existing snapshot from which to make a copy. |
| tags Optional | array A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. |
| 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 |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
clusterConfiguration:
description: string
engineVersion: string
maintenanceWindow: string
name: string
nodeType: string
numShards: integer
parameterGroupName: string
port: integer
shards:
configuration:
replicaCount: integer
slots: string
name: string
size: string
snapshotCreationTime: string
snapshotRetentionLimit: integer
snapshotWindow: string
subnetGroupName: string
topicARN: string
vpcID: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
source: string
status: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat 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. 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. |
| clusterConfiguration Optional | object The configuration of the cluster from which the snapshot was taken |
| clusterConfiguration.description Optional | string |
| clusterConfiguration.engineVersion Optional | string |
| clusterConfiguration.maintenanceWindow Optional | string |
| clusterConfiguration.name Optional | string |
| clusterConfiguration.nodeType Optional | string |
| clusterConfiguration.numShards Optional | integer |
| clusterConfiguration.parameterGroupName Optional | string |
| clusterConfiguration.port Optional | integer |
| clusterConfiguration.shards Optional | array |
| clusterConfiguration.shards.[] Required | object Provides details of a shard in a snapshot |
| clusterConfiguration.shards.[].configuration.replicaCount Optional | integer |
| clusterConfiguration.shards.[].configuration.slots Optional | string |
| clusterConfiguration.shards.[].name Optional | string |
| clusterConfiguration.shards.[].size Optional | string |
| clusterConfiguration.shards.[].snapshotCreationTime Optional | string |
| clusterConfiguration.snapshotRetentionLimit Optional | integer |
| clusterConfiguration.snapshotWindow Optional | string |
| clusterConfiguration.subnetGroupName Optional | string |
| clusterConfiguration.topicARN Optional | string |
| clusterConfiguration.vpcID Optional | string |
| conditions Optional | array All CRS managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe 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 |
| source Optional | string Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual). |
| status Optional | string The status of the snapshot. Valid values: creating |