ServerlessCacheSnapshot
elasticache.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | elasticache-controller/apis/v1alpha1#ServerlessCacheSnapshot |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | ServerlessCacheSnapshot |
| ListKind | ServerlessCacheSnapshotList |
| Plural | serverlesscachesnapshots |
| Singular | serverlesscachesnapshot |
The resource representing a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
Spec
kmsKeyID: string
kmsKeyRef:
from:
name: string
namespace: string
serverlessCacheName: string
serverlessCacheRef:
from:
name: string
namespace: string
serverlessCacheSnapshotName: string
tags:
- key: string
value: string
| Field | Description |
|---|---|
| kmsKeyID Optional | string The ID of the KMS key used to encrypt the snapshot. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL |
| 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 |
| serverlessCacheName Optional | string The name of an existing serverless cache. The snapshot is created from this cache. Available for Valkey, Redis OSS and Serverless Memcached only. |
| serverlessCacheRef 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 |
| serverlessCacheRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| serverlessCacheRef.from.name Optional | string |
| serverlessCacheRef.from.namespace Optional | string |
| serverlessCacheSnapshotName Required | string The name for the snapshot being created. Must be unique for the customer account. Available for Valkey, Redis OSS and Serverless Memcached only. Must be between 1 and 255 characters. |
| tags Optional | array A list of tags to be added to the snapshot resource. A tag is a key-value pair. Available for Valkey, Redis OSS and Serverless Memcached only. |
| 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.[].value Optional | string |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
bytesUsedForCache: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
createTime: string
expiryTime: string
serverlessCacheConfiguration:
engine: string
majorEngineVersion: string
serverlessCacheName: string
snapshotType: 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. |
| bytesUsedForCache Optional | string The total size of a serverless cache snapshot, in bytes. Available for Valkey, Redis OSS and Serverless Memcached only. |
| 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 |
| createTime Optional | string The date and time that the source serverless cache’s metadata and cache data set was obtained for the snapshot. Available for Valkey, Redis OSS and Serverless Memcached only. |
| expiryTime Optional | string The time that the serverless cache snapshot will expire. Available for Valkey, Redis OSS and Serverless Memcached only. |
| serverlessCacheConfiguration Optional | object The configuration of the serverless cache, at the time the snapshot was taken. Available for Valkey, Redis OSS and Serverless Memcached only. |
| serverlessCacheConfiguration.engine Optional | string |
| serverlessCacheConfiguration.majorEngineVersion Optional | string |
| serverlessCacheConfiguration.serverlessCacheName Optional | string |
| snapshotType Optional | string The type of snapshot of serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only. |
| status Optional | string The current status of the serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only. |