- API Reference
ValkeyInstance
This feature is available for the following tiers: Standard, Premium.
Packages:
database.entigo.com/v1alpha1
Resource Types:
ValkeyInstance
↩ Parent| Name | Type | Description | Required |
|---|---|---|---|
| apiVersion | string | database.entigo.com/v1alpha1 | true |
| kind | string | ValkeyInstance | true |
| metadata | object | Refer to the Kubernetes API documentation for the fields of the metadata field. | true |
| spec | object | true | |
| status | object | false |
ValkeyInstance.spec
↩ Parent| Name | Type | Description | Required |
|---|---|---|---|
| engineVersion | string | Cache engine version. ElastiCache automatically uses the latest patch version. For supported versions, see: https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/supported-engine-versions.html Default: 8.2 | true |
| instanceType | string | ElastiCache instance type determines memory, compute, and network capacity. For a list of available instance types, see: https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html Default: cache.t4g.small | true |
| autoMinorVersionUpgrade | boolean | Indicates that minor engine upgrades will be applied automatically during the maintenance window. Default: true | false |
| deletionProtection | boolean | Deletion protection for the ElastiCache replication group. Default: true | false |
| maintenanceWindow | string | Weekly time range during which system maintenance can occur (in UTC). Format: ddd:hh24:mi-ddd:hh24:mi. Example: "sun:05:00-sun:06:00" Must be at least 60 minutes. Default: sun:05:00-sun:06:00 | false |
| numCacheClusters | integer | Number of cache clusters in the replication group (1 primary + replicas). Minimum 2 required (1 primary + 1 replica). Maximum 6 (1 primary + 5 replicas). Default: 2 | false |
| parameterGroupName | string | Name of the parameter group to associate with this replication group. If not specified, the default parameter group for the engine version is used. | false |
| snapshotRetentionLimit | integer | Number of days for which ElastiCache retains automatic snapshots before deleting them. Set to 0 to disable automated backups. Default: 7 | false |
| snapshotWindow | string | Daily time range (in UTC) during which ElastiCache begins taking daily snapshots. Format: hh24:mi-hh24:mi. Example: "03:00-05:00" Must not overlap with maintenance_window. Default: 03:00-05:00 | false |
ValkeyInstance.status
↩ Parent| Name | Type | Description | Required |
|---|---|---|---|
| primaryEndpoint | string | Valkey Instance primary endpoint | false |