SnapshotList (elasticache.services.k8s.aws/v1alpha1)

Type: object

SnapshotList is a list of Snapshot

Type: string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Type: array

List of snapshots. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

No Additional Items

Each item of this array must be:

aws.k8s.services.elasticache.v1alpha1.Snapshot

Type: object

Snapshot is the Schema for the Snapshots API

Type: string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Type: string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Type: object

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

Each additional property must conform to the following schema

Type: string

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: integerFormat: int64

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Same definition as creationTimestamp

Type: array of string

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

No Additional Items

Each item of this array must be:

Type: string

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

Type: integerFormat: int64

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

Type: object

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

Each additional property must conform to the following schema

Type: string

Type: array

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

No Additional Items

Each item of this array must be:

io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Type: object

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

Type: string

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

Type: string

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1

Type: object

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

Type: string

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

Type: string

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

Same definition as creationTimestamp

Type: string

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

Type: array

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

No Additional Items

Each item of this array must be:

io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Type: object

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

Type: boolean

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

Type: string

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: string

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

Type: string

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: object

SnapshotSpec defines the desired state of Snapshot.

Represents a copy of an entire Valkey or Redis OSS cluster as of the time
when the snapshot was taken.

Type: string

The identifier of an existing cluster. The snapshot is created from this
cluster.

Type: string

The ID of the KMS key used to encrypt the snapshot.

Type: string

The identifier of an existing replication group. The snapshot is created
from this replication group.

Type: string

A name for the snapshot being created.

Type: string

The name of an existing snapshot from which to make a copy.

Type: array of object

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.

No Additional Items

Each item of this array must be:

Type: 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.

Type: object

SnapshotStatus defines the observed state of Snapshot

Type: 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

Type: 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

Type: string

OwnerAccountID is the AWS Account ID of the account that owns the
backend AWS service API resource.

Type: string

Partition is the AWS partition in which the resource exists or will exist

Type: string

Region is the AWS region in which the resource exists or will exist.

Type: boolean

If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and
above, set this parameter to yes if you want to opt-in to the next auto minor
version upgrade campaign. This parameter is disabled for previous versions.

Type: string

Indicates the status of automatic failover for the source Valkey or Redis
OSS replication group.

Type: stringFormat: date-time

The date and time when the source cluster was created.

Type: string

The name of the compute and memory capacity node type for the source cluster.

The following node types are supported by ElastiCache. Generally speaking,
the current generation types provide more memory and computational power
at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose: Current generation: M7g node types: cache.m7g.large,
    cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge,
    cache.m7g.12xlarge, cache.m7g.16xlarge For region availability, see Supported
    Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
    M6g node types (available only for Redis OSS engine version 5.0.6 onward
    and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge,
    cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge,
    cache.m6g.16xlarge M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge,
    cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types:
    cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
    T4g node types (available only for Redis OSS engine version 5.0.6 onward
    and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small,
    cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
    T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous
    generation: (not recommended. Existing clusters are still supported but
    creation of new clusters is not supported for these types.) T1 node types:
    cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large,
    cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge,
    cache.m3.2xlarge

  • Compute optimized: Previous generation: (not recommended. Existing clusters
    are still supported but creation of new clusters is not supported for
    these types.) C1 node types: cache.c1.xlarge

  • Memory optimized: Current generation: R7g node types: cache.r7g.large,
    cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge,
    cache.r7g.12xlarge, cache.r7g.16xlarge For region availability, see Supported
    Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
    R6g node types (available only for Redis OSS engine version 5.0.6 onward
    and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge,
    cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge,
    cache.r6g.16xlarge R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
    cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types:
    cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge,
    cache.r4.16xlarge Previous generation: (not recommended. Existing clusters
    are still supported but creation of new clusters is not supported for
    these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
    R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge,
    cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Valkey or Redis OSS append-only files (AOF) are not supported for T1
    or T2 instances.

  • Valkey or Redis OSS Multi-AZ with automatic failover is not supported
    on T1 instances.

  • The configuration variables appendonly and appendfsync are not supported
    on Valkey, or on Redis OSS version 2.8.22 and later.

Type: string

The cache parameter group that is associated with the source cluster.

Type: string

The name of the cache subnet group associated with the source cluster.

Type: array of object

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

No Additional Items

Each item of this array must be:

Type: 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

Type: stringFormat: date-time

Last time the condition transitioned from one status to another.

Type: string

A human readable message indicating details about the transition.

Type: string

The reason for the condition's last transition.

Type: string

Status of the condition, one of True, False, Unknown.

Type: string

Type is the type of the Condition

Type: string

Enables data tiering. Data tiering is only supported for replication groups
using the r6gd node type. This parameter must be set to true when using r6gd
nodes. For more information, see Data tiering (https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/data-tiering.html).

Type: string

The name of the cache engine (memcached or redis) used by the source cluster.

Type: string

The version of the cache engine version that is used by the source cluster.

Type: array of object

A list of the cache nodes in the source cluster.

No Additional Items

Each item of this array must be:

Type: object

Represents an individual cache node in a snapshot of a cluster.

Type: object

Node group (shard) configuration options. Each node group (shard) configuration
has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones,
ReplicaCount.

Type: integerFormat: int64

The number of cache nodes in the source cluster.

For clusters running Valkey or Redis OSS, this value must be 1. For clusters
running Memcached, this value must be between 1 and 40.

Type: integerFormat: int64

The number of node groups (shards) in this snapshot. When restoring from
a snapshot, the number of node groups (shards) in the snapshot and in the
restored replication group must be the same.

Type: integerFormat: int64

The port number used by each cache nodes in the source cluster.

Type: string

The name of the Availability Zone in which the source cluster is located.

Type: 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.

Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:23:00-mon:01:30

Type: string

The ARN (Amazon Resource Name) of the preferred outpost.

Type: string

A description of the source replication group.

Type: integerFormat: int64

For an automatic snapshot, the number of days for which ElastiCache retains
the snapshot before deleting it.

For manual snapshots, this field reflects the SnapshotRetentionLimit for
the source cluster when the snapshot was created. This field is otherwise
ignored: Manual snapshots do not expire, and can only be deleted using the
DeleteSnapshot operation.

Important If the value of SnapshotRetentionLimit is set to zero (0), backups
are turned off.

Type: string

Indicates whether the snapshot is from an automatic backup (automated) or
was created manually (manual).

Type: string

The status of the snapshot. Valid values: creating | available | restoring
| copying | deleting.

Type: string

The daily time range during which ElastiCache takes daily snapshots of the
source cluster.

Type: string

The Amazon Resource Name (ARN) for the topic used by the source cluster for
publishing notifications.

Type: string

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet
group for the source cluster.

Type: string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta

Type: object

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.

Type: integerFormat: int64

remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.

Type: string

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency