ElastiCache

9 resource kinds. Generated from the operator's CRD schemas.

API Group: 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

FieldTypeRequiredDescription
autoMinorVersionUpgradeboolean—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.
azModestring—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.
cacheNodeTypestringyesThe compute and memory capacity of the nodes in the node group (shard).
cacheParameterGroupNamestring—The name of the parameter group to associate with this cluster.
cacheSecurityGroupNamesarray<string>—A list of security group names to associate with this cluster.
cacheSubnetGroupNamestring—The name of the subnet group to be used for the cluster.
clusterNamestring—A name for the cache cluster.
enginestringyesThe name of the cache engine to be used for this cluster.
engineVersionstring—The version number of the cache engine to be used for this cluster
ipDiscoverystring—The Ip Discovery parameter for cachecluster.
logDeliveryConfigurationsarray<object>—Specifies the destination, format and type of the logs
logDeliveryConfigurations[].destinationDetailsobjectyesConfiguration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
logDeliveryConfigurations[].destinationDetails.cloudWatchLogsDetailsobject—The configuration details of the CloudWatch Logs destination
logDeliveryConfigurations[].destinationDetails.cloudWatchLogsDetails.logGroupstringyesThe name of the CloudWatch Logs log group.
logDeliveryConfigurations[].destinationDetails.kinesisFirehoseDetailsobject—The configuration details of the Kinesis Data Firehose destination.
logDeliveryConfigurations[].destinationDetails.kinesisFirehoseDetails.deliveryStreamstringyesThe name of the Kinesis Data Firehose delivery stream
logDeliveryConfigurations[].destinationTypestringyesSpecify either CloudWatch Logs or Kinesis Data Firehose as the destination type.
logDeliveryConfigurations[].logFormatstringyesValid values are either json or text
logDeliveryConfigurations[].logTypestringyesValid value is either slow-log, which refers to slow-log or engine-log
networkTypestring—The network type parameter for cachecluster.
notificationTopicArnstring—The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
numCacheNodesintegeryesThe number of cache nodes that the cache cluster should have.
portinteger—The port number on which each of the cache nodes accepts connections.
preferredAvailabilityZonestring—The EC2 Availability Zone in which the cluster is created.
preferredAvailabilityZonesarray<string>—A list of the Availability Zones in which cache nodes are created.
preferredMaintenanceWindowstring—Specifies the weekly time range during which maintenance on the cluster is performed.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
snapshotArnsarray<string>—A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3.
snapshotNamestring—The name of a Redis snapshot from which to restore data into the new node group (shard).
snapshotRetentionLimitinteger—The number of days for which ElastiCache retains automatic snapshots before deleting them.
snapshotWindowstring—The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
tagsarray<object>—A list of tags to be added to this resource.
tags[].keystringyes
tags[].valuestringyes
transitEncryptionEnabledboolean—A flag that enables in-transit encryption when set to true.
vpcSecurityGroupIdsarray<string>—One or more VPC security groups associated with the cluster.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
configurationEndpointobject—Specifies the ConfigurationEndpoint address and port Read-only: reported by AWS after creation.
configurationEndpoint.addressstring—
configurationEndpoint.portstring—
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
redisEndpointobject—Specifies the RedisEndPoint address and port Read-only: reported by AWS after creation.
redisEndpoint.addressstring—
redisEndpoint.portstring—
requestTokenstring—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

FieldTypeRequiredDescription
automaticFailoverEnabledboolean—AutomaticFailoverEnabled
cacheNodeTypestring—The cache node type of the Global Datastore
cacheParameterGroupNamestring—Cache parameter group name to use for the new engine version.
enginestring—The engine of the Global Datastore.
engineVersionstring—The engine version of the Global Datastore.
globalNodeGroupCountinteger—Indicates the number of node groups in the Global Datastore.
globalReplicationGroupDescriptionstring—The optional description of the Global Datastore
globalReplicationGroupIdSuffixstring—The suffix name of a Global Datastore.
membersarray<object>yesThe replication groups that comprise the Global Datastore.
members[].replicationGroupIdstring—Regionally unique identifier for the member i.e.
members[].replicationGroupRegionstring—The AWS region of the Global Datastore member.
members[].roleenum—Indicates the role of the member, primary or secondary. Allowed: PRIMARY, SECONDARY
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
regionalConfigurationsarray<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[].replicationGroupIdstring—The replication group id of the Global Datastore member.
regionalConfigurations[].replicationGroupRegionstring—The AWS region of the Global Datastore member.
regionalConfigurations[].reshardingConfigurationsarray<object>—A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.
regionalConfigurations[].reshardingConfigurations[].nodeGroupIdstring—Unique identifier for the Node Group.
regionalConfigurations[].reshardingConfigurations[].preferredAvailabilityZonesarray<string>—A list of preferred availability zones for the nodes of new node groups.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
globalReplicationGroupIdstring—The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
statusstring—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

FieldTypeRequiredDescription
cacheParameterGroupFamilystringyesCacheParameterGroupFamily is the engine family (e.g., redis7, memcached1.6).
cacheParameterGroupNamestringyesCacheParameterGroupName is the name of the parameter group.
descriptionstring—Description is a description for the parameter group.
parametersarray<object>—Parameters are the parameter name/value pairs to set.
parameters[].namestringyesName is the parameter name.
parameters[].valuestringyesValue is the parameter value.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
tagsmap<string>—Tags are AWS resource tags to apply.

Status

FieldTypeRequiredDescription
arnstring—ARN is the ARN of the parameter group.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—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

FieldTypeRequiredDescription
atRestEncryptionboolean—AtRestEncryption enables encryption at rest.
authTokenstring—AuthToken is the literal auth token value.
authTokenRefobject—AuthTokenRef references a Kubernetes Secret containing the auth token for transit-encrypted clusters.
authTokenRef.keystringyesKey is the key within the Secret whose value to use.
authTokenRef.namestringyesName of the Kubernetes Secret.
automaticFailoverboolean—AutomaticFailover enables automatic failover to a read replica on primary failure.
cacheNodeTypestringyesCacheNodeType is the instance type (e.g.
descriptionstringyesDescription is a human-readable description of the replication group.
engineenumyesEngine is the cache engine: redis or valkey. Allowed: redis, valkey
engineVersionstring—EngineVersion is the cache engine version (e.g.
numCacheClustersinteger—NumCacheClusters is the number of cache clusters (nodes) in the replication group.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
replicationGroupIdstringyesReplicationGroupID is the identifier for the replication group.
securityGroupRefsarray<object>—SecurityGroupRefs is the list of security group references.
securityGroupRefs[].idstring—ID is a direct AWS Security Group ID (e.g.
securityGroupRefs[].namestring—Name of a SecurityGroup CR in the same namespace.
snapshotRetentionLimitinteger—SnapshotRetentionLimit is the number of days to retain automatic snapshots.
subnetGroupRefstring—SubnetGroupRef is the name of an ElastiCacheSubnetGroup CR in the same namespace.
tagsmap<string>—Tags are AWS resource tags to apply.
transitEncryptionboolean—TransitEncryption enables in-transit encryption (TLS).

Status

FieldTypeRequiredDescription
arnstring—ARN is the Amazon Resource Name of the replication group.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—ObservedGeneration is the most recent .metadata.generation reconciled.
primaryEndpointstring—PrimaryEndpoint is the primary node endpoint.
readerEndpointstring—ReaderEndpoint is the reader endpoint for read replicas.
statusstring—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

FieldTypeRequiredDescription
descriptionstring—Description is an optional description.
engineenumyesEngine is the cache engine (valkey or redis). Allowed: redis, valkey
kmsKeyIdstring—KMSKeyID is the ARN or ID of the KMS key for encryption.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
securityGroupIdsarray<string>—SecurityGroupIDs are the VPC security group IDs.
serverlessCacheNamestringyesServerlessCacheName is the unique name for the serverless cache.
snapshotRetentionLimitinteger—SnapshotRetentionLimit is the number of days to retain backups.
subnetIdsarray<string>—SubnetIDs are the subnet IDs for the cache.
tagsmap<string>—Tags are AWS resource tags to apply.

Status

FieldTypeRequiredDescription
arnstring—ARN is the ARN of the serverless cache.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
endpointstring—Endpoint is the cache endpoint.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—ObservedGeneration is the most recent .metadata.generation reconciled.
statusstring—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

FieldTypeRequiredDescription
kmsKeyIdstring—The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the snapshot.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
serverlessCacheNamestringyesThe name of an existing serverless cache.
serverlessCacheSnapshotNamestringyesThe name of the serverless cache snapshot.
tagsarray<object>—A list of tags to be added to the serverless cache snapshot resource.
tags[].keystringyes
tags[].valuestringyes

Status

FieldTypeRequiredDescription
arnstring—The Amazon Resource Name (ARN) of the serverless cache snapshot.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
bytesUsedForCachestring—The total size of the serverless cache snapshot, in bytes.
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
createTimestring—The date and time that the source serverless cache's metadata and cache data set was obtained for the snapshot.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
serverlessCacheConfigurationobject—The configuration of the serverless cache, at the time the snapshot was taken.
serverlessCacheConfiguration.enginestring—The engine that the serverless cache is configured with.
serverlessCacheConfiguration.majorEngineVersionstring—The engine version number that the serverless cache is configured with.
serverlessCacheConfiguration.serverlessCacheNamestring—The identifier of the serverless cache.
snapshotTypestring—The type of snapshot of the serverless cache.
statusstring—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

FieldTypeRequiredDescription
descriptionstringyesDescription is a human-readable description of the subnet group.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
subnetGroupNamestringyesSubnetGroupName is the name of the subnet group.
subnetRefsarray<object>yesSubnetRefs is the list of subnets in the group.
subnetRefs[].idstring—ID is a direct AWS Subnet ID (e.g.
subnetRefs[].namestring—Name of a Subnet CR in the same namespace.
tagsmap<string>—Tags are AWS resource tags to apply.

Status

FieldTypeRequiredDescription
arnstring—ARN is the Amazon Resource Name of the subnet group.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—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

FieldTypeRequiredDescription
accessStringstring—Access permissions string used for this user account.
authenticationModeobject—ElastiCacheUserAuthenticationMode is a nested property type of AWS::ElastiCache::User.
authenticationMode.passwordsarray<string>—Passwords used for this user account.
authenticationMode.typeenumyesAuthentication Type Allowed: password, no-password-required, iam
engineenumyesThe target cache engine for the user. Allowed: redis, valkey
noPasswordRequiredboolean—Indicates a password is not required for this user account.
passwordsarray<string>—Passwords used for this user account.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
tagsarray<object>—An array of key-value pairs to apply to this user.
tags[].keystringyes
tags[].valuestringyes
userIdstringyesThe ID of the user.
userNamestringyesThe username of the user.

Status

FieldTypeRequiredDescription
arnstring—The Amazon Resource Name (ARN) of the user account.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
statusstring—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

FieldTypeRequiredDescription
engineenumyesThe target cache engine for the user group. Allowed: redis, valkey
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
tagsarray<object>—An array of key-value pairs to apply to this user.
tags[].keystringyes
tags[].valuestringyes
userGroupIdstringyesThe ID of the user group.
userIdsarray<string>yesList of users associated to this user group.

Status

FieldTypeRequiredDescription
arnstring—The Amazon Resource Name (ARN) of the user account.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
statusstring—Indicates user group status.