ServerlessCache

elasticache.services.k8s.aws/v1alpha1

TypeLink
GoDocelasticache-controller/apis/v1alpha1#ServerlessCache

Metadata

PropertyValue
ScopeNamespaced
KindServerlessCache
ListKindServerlessCacheList
Pluralserverlesscaches
Singularserverlesscache

The resource representing a serverless cache.

Spec

cacheUsageLimits: 
  dataStorage: 
    maximum: integer
    minimum: integer
    unit: string
  eCPUPerSecond: 
    maximum: integer
    minimum: integer
dailySnapshotTime: string
description: string
engine: string
kmsKeyID: string
majorEngineVersion: string
securityGroupIDs:
- string
securityGroupRefs:
  from: 
    name: string
    namespace: string
serverlessCacheName: string
snapshotARNsToRestore:
- string
snapshotRetentionLimit: integer
subnetIDs:
- string
subnetRefs:
  from: 
    name: string
    namespace: string
tags:
- key: string
  value: string
userGroupID: string
FieldDescription
cacheUsageLimits
Optional
object
Sets the cache usage limits for storage and ElastiCache Processing Units
for the cache.
cacheUsageLimits.dataStorage
Optional
object
The data storage limit.
cacheUsageLimits.dataStorage.maximum
Optional
integer
cacheUsageLimits.dataStorage.minimum
Optional
integer
cacheUsageLimits.dataStorage.unit
Optional
string
cacheUsageLimits.eCPUPerSecond
Optional
object
The configuration for the number of ElastiCache Processing Units (ECPU) the
cache can consume per second.
cacheUsageLimits.eCPUPerSecond.maximum
Optional
integer
cacheUsageLimits.eCPUPerSecond.minimum
Optional
integer
dailySnapshotTime
Optional
string
The daily time that snapshots will be created from the new serverless cache.
By default this number is populated with 0, i.e. no snapshots will be created
on an automatic daily basis. Available for Valkey, Redis OSS and Serverless
Memcached only.
description
Optional
string
User-provided description for the serverless cache. The default is NULL,
i.e. if no description is provided then an empty string will be returned.
The maximum length is 255 characters.
engine
Required
string
The name of the cache engine to be used for creating the serverless cache.
kmsKeyID
Optional
string
ARN of the customer managed key for encrypting the data at rest. If no KMS
key is provided, a default service key is used.
majorEngineVersion
Optional
string
The version of the cache engine that will be used to create the serverless
cache.
securityGroupIDs
Optional
array
A list of the one or more VPC security groups to be associated with the serverless
cache. The security group will authorize traffic access for the VPC end-point
(private-link). If no other information is given this will be the VPC’s
Default Security Group that is associated with the cluster VPC end-point.
securityGroupIDs.[]
Required
string
securityGroupRefs.[]
Required
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 || **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
| | serverlessCacheName
Required | string
User-provided identifier for the serverless cache. This parameter is stored
as a lowercase string. | | snapshotARNsToRestore
Optional | array
The ARN(s) of the snapshot that the new serverless cache will be created
from. Available for Valkey, Redis OSS and Serverless Memcached only. | | snapshotARNsToRestore.[]
Required | string
|| snapshotRetentionLimit
Optional | integer
The number of snapshots that will be retained for the serverless cache that
is being created. As new snapshots beyond this limit are added, the oldest
snapshots will be deleted on a rolling basis. Available for Valkey, Redis
OSS and Serverless Memcached only. | | subnetIDs
Optional | array
A list of the identifiers of the subnets where the VPC endpoint for the serverless
cache will be deployed. All the subnetIds must belong to the same VPC. | | subnetIDs.[]
Required | string
|| subnetRefs
Optional | array
| | subnetRefs.[]
Required | 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 || **subnetRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |

| subnetRefs.[].from.name
Optional | string
| | subnetRefs.[].from.namespace
Optional | string
| | tags
Optional | array
The list of tags (key, value) pairs to be added to the serverless cache resource.
Default is NULL. | | 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.[].key
Optional | string
| | tags.[].value
Optional | string
| | userGroupID
Optional | string
The identifier of the UserGroup to be associated with the serverless cache.
Available for Valkey and Redis OSS only. Default is NULL. |

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
createTime: string
endpoint: 
  address: string
  port: integer
fullEngineVersion: string
readerEndpoint: 
  address: string
  port: integer
status: string
FieldDescription
ackResourceMetadata
Optional
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
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.
conditions
Optional
array
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
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
When the serverless cache was created.
endpoint
Optional
object
Represents the information required for client programs to connect to a cache
node. This value is read-only.
endpoint.address
Optional
string
endpoint.port
Optional
integer
fullEngineVersion
Optional
string
The name and version number of the engine the serverless cache is compatible
with.
readerEndpoint
Optional
object
Represents the information required for client programs to connect to a cache
node. This value is read-only.
readerEndpoint.address
Optional
string
readerEndpoint.port
Optional
integer
status
Optional
string
The current status of the serverless cache. The allowed values are CREATING,
AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.