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

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

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

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.

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

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

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

Reserved parameter. The password used to access a password protected server.

Password constraints:

• Must be only printable ASCII characters.

• Must be at least 16 characters and no more than 128 characters in length.

Specifies whether the nodes in this Memcached cluster are created in a single
Availability Zone or created across multiple Availability Zones in the cluster's
region.

This parameter is only supported for Memcached clusters.

If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache
assumes single-az mode.

The node group (shard) identifier. This parameter is stored as a lowercase
string.

Constraints:

• A name must contain from 1 to 50 alphanumeric characters or hyphens.

• The first character must be a letter.

• A name cannot end with a hyphen or contain two consecutive hyphens.

The compute and memory capacity of the nodes in the node group (shard).

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.

AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using 'from' field
Ex:
APIIDRef:

from:
  name: my-api

The name of the subnet group to be used for the cluster.

Use this parameter only when you are creating a cluster in an Amazon Virtual
Private Cloud (Amazon VPC).

If you're going to launch your cluster in an Amazon VPC, you need to create
a subnet group before you start creating a cluster. For more information,
see Subnets and Subnet Groups (https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SubnetGroups.html).

AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using 'from' field
Ex:
APIIDRef:

from:
  name: my-api

The version number of the cache engine to be used for this cluster. To view
the supported cache engine versions, use the DescribeCacheEngineVersions
operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache
Engine and Version (https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SelectEngine.html#VersionManagement)),
but you cannot downgrade to an earlier engine version. If you want to use
an earlier engine version, you must delete the existing cluster or replication
group and create it anew with the earlier engine version.

AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using 'from' field
Ex:
APIIDRef:

from:
  name: my-api

The initial number of cache nodes that the cluster has.

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

If you need more than 40 nodes for your Memcached cluster, please fill out
the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/
(http://aws.amazon.com/contact-us/elasticache-node-limit-request/).

The EC2 Availability Zone in which the cluster is created.

All nodes belonging to this cluster are placed in the preferred Availability
Zone. If you want to create your nodes across multiple Availability Zones,
use PreferredAvailabilityZones.

Default: System chosen Availability Zone.

A list of the Availability Zones in which cache nodes are created. The order
of the zones in the list is not important.

This option is only supported on Memcached.

If you are creating your cluster in an Amazon VPC (recommended) you can only
locate nodes in Availability Zones that are associated with the subnets in
the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheNodes.

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone
instead, or repeat the Availability Zone multiple times in the list.

Default: System chosen Availability Zones.

The ID of the replication group to which this cluster should belong. If this
parameter is specified, the cluster is added to the specified replication
group as a read replica; otherwise, the cluster is a standalone primary that
is not part of any replication group.

If the specified replication group is Multi-AZ enabled and the Availability
Zone is not specified, the cluster is created in Availability Zones that
provide the best spread of read replicas across Availability Zones.

This parameter is only valid if the Engine parameter is redis.

AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using 'from' field
Ex:
APIIDRef:

from:
  name: my-api

A single-element string list containing an Amazon Resource Name (ARN) that
uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon
S3. The snapshot file is used to populate the node group (shard). The Amazon
S3 object name in the ARN cannot contain any commas.

This parameter is only valid if the Engine parameter is redis.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

The name of a Valkey or Redis OSS snapshot from which to restore data into
the new node group (shard). The snapshot status changes to restoring while
the new node group (shard) is being created.

This parameter is only valid if the Engine parameter is redis.

AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using 'from' field
Ex:
APIIDRef:

from:
  name: my-api

The number of days for which ElastiCache retains automatic snapshots before
deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot
taken today is retained for 5 days before being deleted.

This parameter is only valid if the Engine parameter is redis.

Default: 0 (i.e., automatic backups are disabled for this cache cluster).

The daily time range (in UTC) during which ElastiCache begins taking a daily
snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an
appropriate time range.

This parameter is only valid if the Engine parameter is redis.

A flag that enables encryption at-rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the cluster
is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled
to true when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC
using Redis OSS version 3.2.6, 4.x or later.

Default: false

Represents a Memcached cluster endpoint which can be used by an application
to connect to any node in the cluster. The configuration endpoint will always
have .cfg in it.

Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211