ElastiCache
9 resource kinds. Generated from the operator's CRD schemas.
aws.konfig.io/v1alpha1
ElastiCacheCacheCluster # CLOUD CONTROL · AWS::ElastiCache::CacheCluster
ElastiCacheCacheCluster manages AWS::ElastiCache::CacheCluster through the AWS Cloud Control API.
kubectl get elasticachecacheclusters · example on GitHub
Example
# ElastiCacheCacheCluster — ElastiCache
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/elasticache.html#elasticachecachecluster
apiVersion: aws.konfig.io/v1alpha1
kind: ElastiCacheCacheCluster
metadata:
name: example-elasticachecachecluster
namespace: default
spec:
autoMinorVersionUpgrade: false
azMode: example
cacheNodeType: example
cacheParameterGroupName: example-elasticachecachecluster
cacheSecurityGroupNames:
- example
cacheSubnetGroupName: example-elasticachecachecluster
clusterName: example-elasticachecachecluster
engine: example
engineVersion: example
ipDiscovery: example
logDeliveryConfigurations:
- destinationType: example
logFormat: example
logType: example
networkType: example
notificationTopicArn: arn:aws:iam::123456789012:role/example-role
numCacheNodes: 1
port: 443
preferredAvailabilityZone: us-east-1a
preferredAvailabilityZones:
- us-east-1a
preferredMaintenanceWindow: example
providerRef:
name: example-elasticachecachecluster
region: us-east-1
snapshotArns:
- example
snapshotName: example-elasticachecachecluster
snapshotRetentionLimit: 7
snapshotWindow: example
tags:
- key: example
value: example
transitEncryptionEnabled: true
vpcSecurityGroupIds:
- example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
autoMinorVersionUpgrade | boolean | — | If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. |
azMode | string | — | 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. |
cacheNodeType | string | yes | The compute and memory capacity of the nodes in the node group (shard). |
cacheParameterGroupName | string | — | The name of the parameter group to associate with this cluster. |
cacheSecurityGroupNames | array<string> | — | A list of security group names to associate with this cluster. |
cacheSubnetGroupName | string | — | The name of the subnet group to be used for the cluster. |
clusterName | string | — | A name for the cache cluster. |
engine | string | yes | The name of the cache engine to be used for this cluster. |
engineVersion | string | — | The version number of the cache engine to be used for this cluster |
ipDiscovery | string | — | The Ip Discovery parameter for cachecluster. |
logDeliveryConfigurations | array<object> | — | Specifies the destination, format and type of the logs |
logDeliveryConfigurations[].destinationDetails | object | yes | Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination. |
logDeliveryConfigurations[].destinationDetails.cloudWatchLogsDetails | object | — | The configuration details of the CloudWatch Logs destination |
logDeliveryConfigurations[].destinationDetails.cloudWatchLogsDetails.logGroup | string | yes | The name of the CloudWatch Logs log group. |
logDeliveryConfigurations[].destinationDetails.kinesisFirehoseDetails | object | — | The configuration details of the Kinesis Data Firehose destination. |
logDeliveryConfigurations[].destinationDetails.kinesisFirehoseDetails.deliveryStream | string | yes | The name of the Kinesis Data Firehose delivery stream |
logDeliveryConfigurations[].destinationType | string | yes | Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type. |
logDeliveryConfigurations[].logFormat | string | yes | Valid values are either json or text |
logDeliveryConfigurations[].logType | string | yes | Valid value is either slow-log, which refers to slow-log or engine-log |
networkType | string | — | The network type parameter for cachecluster. |
notificationTopicArn | string | — | The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. |
numCacheNodes | integer | yes | The number of cache nodes that the cache cluster should have. |
port | integer | — | The port number on which each of the cache nodes accepts connections. |
preferredAvailabilityZone | string | — | The EC2 Availability Zone in which the cluster is created. |
preferredAvailabilityZones | array<string> | — | A list of the Availability Zones in which cache nodes are created. |
preferredMaintenanceWindow | string | — | Specifies the weekly time range during which maintenance on the cluster is performed. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
snapshotArns | array<string> | — | A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. |
snapshotName | string | — | The name of a Redis snapshot from which to restore data into the new node group (shard). |
snapshotRetentionLimit | integer | — | The number of days for which ElastiCache retains automatic snapshots before deleting them. |
snapshotWindow | string | — | The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). |
tags | array<object> | — | A list of tags to be added to this resource. |
tags[].key | string | yes | |
tags[].value | string | yes | |
transitEncryptionEnabled | boolean | — | A flag that enables in-transit encryption when set to true. |
vpcSecurityGroupIds | array<string> | — | One or more VPC security groups associated with the cluster. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
configurationEndpoint | object | — | Specifies the ConfigurationEndpoint address and port Read-only: reported by AWS after creation. |
configurationEndpoint.address | string | — | |
configurationEndpoint.port | string | — | |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
redisEndpoint | object | — | Specifies the RedisEndPoint address and port Read-only: reported by AWS after creation. |
redisEndpoint.address | string | — | |
redisEndpoint.port | string | — | |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
ElastiCacheGlobalReplicationGroup # CLOUD CONTROL · AWS::ElastiCache::GlobalReplicationGroup
ElastiCacheGlobalReplicationGroup manages AWS::ElastiCache::GlobalReplicationGroup through the AWS Cloud Control API.
kubectl get elasticacheglobalreplicationgroups · example on GitHub
Example
# ElastiCacheGlobalReplicationGroup — ElastiCache
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/elasticache.html#elasticacheglobalreplicationgroup
apiVersion: aws.konfig.io/v1alpha1
kind: ElastiCacheGlobalReplicationGroup
metadata:
name: example-elasticacheglobalreplicationgroup
namespace: default
spec:
automaticFailoverEnabled: true
cacheNodeType: example
cacheParameterGroupName: example-elasticacheglobalreplicationgroup
engine: example
engineVersion: example
globalNodeGroupCount: 2
globalReplicationGroupDescription: Managed by konfig-konector
globalReplicationGroupIdSuffix: example
members:
- replicationGroupRegion: example
role: PRIMARY
providerRef:
name: example-elasticacheglobalreplicationgroup
region: us-east-1
regionalConfigurations:
- replicationGroupRegion: example
reshardingConfigurations:
- preferredAvailabilityZones:
- us-east-1a
Spec
| Field | Type | Required | Description |
|---|---|---|---|
automaticFailoverEnabled | boolean | — | AutomaticFailoverEnabled |
cacheNodeType | string | — | The cache node type of the Global Datastore |
cacheParameterGroupName | string | — | Cache parameter group name to use for the new engine version. |
engine | string | — | The engine of the Global Datastore. |
engineVersion | string | — | The engine version of the Global Datastore. |
globalNodeGroupCount | integer | — | Indicates the number of node groups in the Global Datastore. |
globalReplicationGroupDescription | string | — | The optional description of the Global Datastore |
globalReplicationGroupIdSuffix | string | — | The suffix name of a Global Datastore. |
members | array<object> | yes | The replication groups that comprise the Global Datastore. |
members[].replicationGroupId | string | — | Regionally unique identifier for the member i.e. |
members[].replicationGroupRegion | string | — | The AWS region of the Global Datastore member. |
members[].role | enum | — | Indicates the role of the member, primary or secondary. Allowed: PRIMARY, SECONDARY |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
regionalConfigurations | array<object> | — | Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore |
regionalConfigurations[].replicationGroupId | string | — | The replication group id of the Global Datastore member. |
regionalConfigurations[].replicationGroupRegion | string | — | The AWS region of the Global Datastore member. |
regionalConfigurations[].reshardingConfigurations | array<object> | — | A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster. |
regionalConfigurations[].reshardingConfigurations[].nodeGroupId | string | — | Unique identifier for the Node Group. |
regionalConfigurations[].reshardingConfigurations[].preferredAvailabilityZones | array<string> | — | A list of preferred availability zones for the nodes of new node groups. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
globalReplicationGroupId | string | — | The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
status | string | — | The status of the Global Datastore Read-only: reported by AWS after creation. |
ElastiCacheParameterGroup # GA
ElastiCacheParameterGroup is the Schema for managing ElastiCache parameter groups.
kubectl get elasticacheparametergroups · example on GitHub
Example
# ElastiCacheParameterGroup — ElastiCache
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/elasticache.html#elasticacheparametergroup
apiVersion: aws.konfig.io/v1alpha1
kind: ElastiCacheParameterGroup
metadata:
name: example-elasticacheparametergroup
namespace: default
spec:
cacheParameterGroupFamily: example
cacheParameterGroupName: example-elasticacheparametergroup
description: Managed by konfig-konector
parameters:
- name: example-elasticacheparametergroup
value: example
providerRef:
name: example-elasticacheparametergroup
region: us-east-1
tags:
environment: dev
team: platform
Spec
| Field | Type | Required | Description |
|---|---|---|---|
cacheParameterGroupFamily | string | yes | CacheParameterGroupFamily is the engine family (e.g., redis7, memcached1.6). |
cacheParameterGroupName | string | yes | CacheParameterGroupName is the name of the parameter group. |
description | string | — | Description is a description for the parameter group. |
parameters | array<object> | — | Parameters are the parameter name/value pairs to set. |
parameters[].name | string | yes | Name is the parameter name. |
parameters[].value | string | yes | Value is the parameter value. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
tags | map<string> | — | Tags are AWS resource tags to apply. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | ARN is the ARN of the parameter group. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
lastSyncTime | string | — | LastSyncTime is when the resource was last successfully reconciled. |
observedGeneration | integer | — | ObservedGeneration is the most recent .metadata.generation reconciled. |
ElastiCacheReplicationGroup # GA
ElastiCacheReplicationGroup is the Schema for managing ElastiCache Replication Groups.
kubectl get elasticachereplicationgroups · example on GitHub
Example
# ElastiCacheReplicationGroup — ElastiCache
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/elasticache.html#elasticachereplicationgroup
apiVersion: aws.konfig.io/v1alpha1
kind: ElastiCacheReplicationGroup
metadata:
name: example-elasticachereplicationgroup
namespace: default
spec:
atRestEncryption: true
authToken: example
authTokenRef:
key: example
name: example-elasticachereplicationgroup
automaticFailover: false
cacheNodeType: example
description: Managed by konfig-konector
engine: redis
engineVersion: example
numCacheClusters: 1
providerRef:
name: example-elasticachereplicationgroup
region: us-east-1
replicationGroupId: example-id
securityGroupRefs:
- name: example-securitygrouprefs
snapshotRetentionLimit: 1
subnetGroupRef: example
tags:
environment: dev
team: platform
transitEncryption: true
Spec
| Field | Type | Required | Description |
|---|---|---|---|
atRestEncryption | boolean | — | AtRestEncryption enables encryption at rest. |
authToken | string | — | AuthToken is the literal auth token value. |
authTokenRef | object | — | AuthTokenRef references a Kubernetes Secret containing the auth token for transit-encrypted clusters. |
authTokenRef.key | string | yes | Key is the key within the Secret whose value to use. |
authTokenRef.name | string | yes | Name of the Kubernetes Secret. |
automaticFailover | boolean | — | AutomaticFailover enables automatic failover to a read replica on primary failure. |
cacheNodeType | string | yes | CacheNodeType is the instance type (e.g. |
description | string | yes | Description is a human-readable description of the replication group. |
engine | enum | yes | Engine is the cache engine: redis or valkey. Allowed: redis, valkey |
engineVersion | string | — | EngineVersion is the cache engine version (e.g. |
numCacheClusters | integer | — | NumCacheClusters is the number of cache clusters (nodes) in the replication group. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
replicationGroupId | string | yes | ReplicationGroupID is the identifier for the replication group. |
securityGroupRefs | array<object> | — | SecurityGroupRefs is the list of security group references. |
securityGroupRefs[].id | string | — | ID is a direct AWS Security Group ID (e.g. |
securityGroupRefs[].name | string | — | Name of a SecurityGroup CR in the same namespace. |
snapshotRetentionLimit | integer | — | SnapshotRetentionLimit is the number of days to retain automatic snapshots. |
subnetGroupRef | string | — | SubnetGroupRef is the name of an ElastiCacheSubnetGroup CR in the same namespace. |
tags | map<string> | — | Tags are AWS resource tags to apply. |
transitEncryption | boolean | — | TransitEncryption enables in-transit encryption (TLS). |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | ARN is the Amazon Resource Name of the replication group. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
lastSyncTime | string | — | LastSyncTime is when the resource was last successfully reconciled. |
observedGeneration | integer | — | ObservedGeneration is the most recent .metadata.generation reconciled. |
primaryEndpoint | string | — | PrimaryEndpoint is the primary node endpoint. |
readerEndpoint | string | — | ReaderEndpoint is the reader endpoint for read replicas. |
status | string | — | Status is the current replication group status. |
ElastiCacheServerlessCache # GA
ElastiCacheServerlessCache is the Schema for managing ElastiCache serverless caches.
kubectl get elasticacheserverlesscaches · example on GitHub
Example
# ElastiCacheServerlessCache — ElastiCache
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/elasticache.html#elasticacheserverlesscache
apiVersion: aws.konfig.io/v1alpha1
kind: ElastiCacheServerlessCache
metadata:
name: example-elasticacheserverlesscache
namespace: default
spec:
description: Managed by konfig-konector
engine: redis
kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
providerRef:
name: example-elasticacheserverlesscache
region: us-east-1
securityGroupIds:
- example
serverlessCacheName: example-elasticacheserverlesscache
snapshotRetentionLimit: 7
subnetIds:
- example
tags:
environment: dev
team: platform
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | — | Description is an optional description. |
engine | enum | yes | Engine is the cache engine (valkey or redis). Allowed: redis, valkey |
kmsKeyId | string | — | KMSKeyID is the ARN or ID of the KMS key for encryption. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
securityGroupIds | array<string> | — | SecurityGroupIDs are the VPC security group IDs. |
serverlessCacheName | string | yes | ServerlessCacheName is the unique name for the serverless cache. |
snapshotRetentionLimit | integer | — | SnapshotRetentionLimit is the number of days to retain backups. |
subnetIds | array<string> | — | SubnetIDs are the subnet IDs for the cache. |
tags | map<string> | — | Tags are AWS resource tags to apply. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | ARN is the ARN of the serverless cache. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
endpoint | string | — | Endpoint is the cache endpoint. |
lastSyncTime | string | — | LastSyncTime is when the resource was last successfully reconciled. |
observedGeneration | integer | — | ObservedGeneration is the most recent .metadata.generation reconciled. |
status | string | — | Status is the current state of the cache. |
ElastiCacheServerlessCacheSnapshot # CLOUD CONTROL · AWS::ElastiCache::ServerlessCacheSnapshot
ElastiCacheServerlessCacheSnapshot manages AWS::ElastiCache::ServerlessCacheSnapshot through the AWS Cloud Control API.
kubectl get elasticacheserverlesscachesnapshots · example on GitHub
Example
# ElastiCacheServerlessCacheSnapshot — ElastiCache
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/elasticache.html#elasticacheserverlesscachesnapshot
apiVersion: aws.konfig.io/v1alpha1
kind: ElastiCacheServerlessCacheSnapshot
metadata:
name: example-elasticacheserverlesscachesnapshot
namespace: default
spec:
kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
providerRef:
name: example-elasticacheserverlesscachesnapshot
region: us-east-1
serverlessCacheName: example-elasticacheserverlesscachesnapshot
serverlessCacheSnapshotName: example-elasticacheserverlesscachesnapshot
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
kmsKeyId | string | — | The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the snapshot. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
serverlessCacheName | string | yes | The name of an existing serverless cache. |
serverlessCacheSnapshotName | string | yes | The name of the serverless cache snapshot. |
tags | array<object> | — | A list of tags to be added to the serverless cache snapshot resource. |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | The Amazon Resource Name (ARN) of the serverless cache snapshot. |
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
bytesUsedForCache | string | — | The total size of the serverless cache snapshot, in bytes. |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
createTime | string | — | The date and time that the source serverless cache's metadata and cache data set was obtained for the snapshot. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
serverlessCacheConfiguration | object | — | The configuration of the serverless cache, at the time the snapshot was taken. |
serverlessCacheConfiguration.engine | string | — | The engine that the serverless cache is configured with. |
serverlessCacheConfiguration.majorEngineVersion | string | — | The engine version number that the serverless cache is configured with. |
serverlessCacheConfiguration.serverlessCacheName | string | — | The identifier of the serverless cache. |
snapshotType | string | — | The type of snapshot of the serverless cache. |
status | string | — | The current status of the serverless cache snapshot. |
ElastiCacheSubnetGroup # GA
ElastiCacheSubnetGroup is the Schema for managing ElastiCache Subnet Groups.
kubectl get elasticachesubnetgroups · example on GitHub
Example
# ElastiCacheSubnetGroup — ElastiCache
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/elasticache.html#elasticachesubnetgroup
apiVersion: aws.konfig.io/v1alpha1
kind: ElastiCacheSubnetGroup
metadata:
name: example-elasticachesubnetgroup
namespace: default
spec:
description: Managed by konfig-konector
providerRef:
name: example-elasticachesubnetgroup
region: us-east-1
subnetGroupName: example-elasticachesubnetgroup
subnetRefs:
- name: example-subnetrefs
tags:
environment: dev
team: platform
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | yes | Description is a human-readable description of the subnet group. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
subnetGroupName | string | yes | SubnetGroupName is the name of the subnet group. |
subnetRefs | array<object> | yes | SubnetRefs is the list of subnets in the group. |
subnetRefs[].id | string | — | ID is a direct AWS Subnet ID (e.g. |
subnetRefs[].name | string | — | Name of a Subnet CR in the same namespace. |
tags | map<string> | — | Tags are AWS resource tags to apply. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | ARN is the Amazon Resource Name of the subnet group. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
lastSyncTime | string | — | LastSyncTime is when the resource was last successfully reconciled. |
observedGeneration | integer | — | ObservedGeneration is the most recent .metadata.generation reconciled. |
ElastiCacheUser # CLOUD CONTROL · AWS::ElastiCache::User
ElastiCacheUser manages AWS::ElastiCache::User through the AWS Cloud Control API.
kubectl get elasticacheusers · example on GitHub
Example
# ElastiCacheUser — ElastiCache
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/elasticache.html#elasticacheuser
apiVersion: aws.konfig.io/v1alpha1
kind: ElastiCacheUser
metadata:
name: example-elasticacheuser
namespace: default
spec:
accessString: example
authenticationMode:
passwords:
- example
type: password
engine: redis
noPasswordRequired: false
passwords:
- example
providerRef:
name: example-elasticacheuser
region: us-east-1
tags:
- key: example
value: example
userId: example-id
userName: example-elasticacheuser
Spec
| Field | Type | Required | Description |
|---|---|---|---|
accessString | string | — | Access permissions string used for this user account. |
authenticationMode | object | — | ElastiCacheUserAuthenticationMode is a nested property type of AWS::ElastiCache::User. |
authenticationMode.passwords | array<string> | — | Passwords used for this user account. |
authenticationMode.type | enum | yes | Authentication Type Allowed: password, no-password-required, iam |
engine | enum | yes | The target cache engine for the user. Allowed: redis, valkey |
noPasswordRequired | boolean | — | Indicates a password is not required for this user account. |
passwords | array<string> | — | Passwords used for this user account. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
tags | array<object> | — | An array of key-value pairs to apply to this user. |
tags[].key | string | yes | |
tags[].value | string | yes | |
userId | string | yes | The ID of the user. |
userName | string | yes | The username of the user. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | The Amazon Resource Name (ARN) of the user account. |
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
status | string | — | Indicates the user status. |
ElastiCacheUserGroup # CLOUD CONTROL · AWS::ElastiCache::UserGroup
ElastiCacheUserGroup manages AWS::ElastiCache::UserGroup through the AWS Cloud Control API.
kubectl get elasticacheusergroups · example on GitHub
Example
# ElastiCacheUserGroup — ElastiCache
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/elasticache.html#elasticacheusergroup
apiVersion: aws.konfig.io/v1alpha1
kind: ElastiCacheUserGroup
metadata:
name: example-elasticacheusergroup
namespace: default
spec:
engine: redis
providerRef:
name: example-elasticacheusergroup
region: us-east-1
tags:
- key: example
value: example
userGroupId: example-id
userIds:
- example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
engine | enum | yes | The target cache engine for the user group. Allowed: redis, valkey |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
tags | array<object> | — | An array of key-value pairs to apply to this user. |
tags[].key | string | yes | |
tags[].value | string | yes | |
userGroupId | string | yes | The ID of the user group. |
userIds | array<string> | yes | List of users associated to this user group. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | The Amazon Resource Name (ARN) of the user account. |
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
status | string | — | Indicates user group status. |