MemoryDB

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

API Group: aws.konfig.io/v1alpha1

MemoryDBACL # CLOUD CONTROL · AWS::MemoryDB::ACL

MemoryDBACL manages AWS::MemoryDB::ACL through the AWS Cloud Control API.

kubectl get memorydbacls · example on GitHub

Example

# MemoryDBACL — MemoryDB
# 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/memorydb.html#memorydbacl
apiVersion: aws.konfig.io/v1alpha1
kind: MemoryDBACL
metadata:
  name: example-memorydbacl
  namespace: default
spec:
  aclName: example-memorydbacl
  providerRef:
    name: example-memorydbacl
    region: us-east-1
  tags:
  - key: example
    value: example
  userNames:
  - example

Spec

Field	Type	Required	Description
`aclName`	string	yes	The name of the acl.
`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 cluster.
`tags[].key`	string	yes
`tags[].value`	string	yes
`userNames`	array<string>	—	List of users associated to this acl.

Status

Field	Type	Required	Description
`arn`	string	—	The Amazon Resource Name (ARN) of the acl.
`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 acl status.

MemoryDBCluster # GA

MemoryDBCluster is the Schema for managing MemoryDB clusters.

kubectl get memorydbclusters · example on GitHub

Example

# MemoryDBCluster — MemoryDB
# 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/memorydb.html#memorydbcluster
apiVersion: aws.konfig.io/v1alpha1
kind: MemoryDBCluster
metadata:
  name: example-memorydbcluster
  namespace: default
spec:
  aclName: example-memorydbcluster
  clusterName: example-memorydbcluster
  engineVersion: example
  kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
  nodeType: example
  numReplicasPerShard: 1
  numShards: 1
  providerRef:
    name: example-memorydbcluster
    region: us-east-1
  securityGroupIds:
  - example
  snapshotRetentionLimit: 7
  subnetGroupName: example-memorydbcluster
  tags:
    environment: dev
    team: platform
  tlsEnabled: true

Spec

Field	Type	Required	Description
`aclName`	string	yes	ACLName is the name of the access control list to associate.
`clusterName`	string	yes	ClusterName is the name of the cluster.
`engineVersion`	string	—	EngineVersion is the Redis OSS version.
`kmsKeyId`	string	—	KMSKeyID is the ARN of the KMS key for encryption at rest.
`nodeType`	string	yes	NodeType is the compute and memory capacity of the nodes.
`numReplicasPerShard`	integer	—	NumReplicasPerShard is the number of replicas per shard.
`numShards`	integer	—	NumShards is the number of shards in the cluster.
`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.
`snapshotRetentionLimit`	integer	—	SnapshotRetentionLimit is the number of days to retain snapshots.
`subnetGroupName`	string	—	SubnetGroupName is the subnet group to use for the cluster.
`tags`	map<string>	—	Tags are AWS resource tags to apply.
`tlsEnabled`	boolean	—	TLSEnabled enables in-transit encryption.

Status

Field	Type	Required	Description
`arn`	string	—	ARN is the ARN of the cluster.
`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 cluster configuration 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 cluster.

MemoryDBMultiRegionCluster # CLOUD CONTROL · AWS::MemoryDB::MultiRegionCluster

MemoryDBMultiRegionCluster manages AWS::MemoryDB::MultiRegionCluster through the AWS Cloud Control API.

kubectl get memorydbmultiregionclusters · example on GitHub

Example

# MemoryDBMultiRegionCluster — MemoryDB
# 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/memorydb.html#memorydbmultiregioncluster
apiVersion: aws.konfig.io/v1alpha1
kind: MemoryDBMultiRegionCluster
metadata:
  name: example-memorydbmultiregioncluster
  namespace: default
spec:
  description: Managed by konfig-konector
  engine: example
  engineVersion: example
  multiRegionClusterNameSuffix: example
  multiRegionParameterGroupName: example-memorydbmultiregioncluster
  nodeType: example
  numShards: 1
  providerRef:
    name: example-memorydbmultiregioncluster
    region: us-east-1
  tags:
  - key: example
    value: example
  tlsEnabled: true
  updateStrategy: COORDINATED

Spec

Field	Type	Required	Description
`description`	string	—	Description of the multi region cluster.
`engine`	string	—	The engine type used by the multi region cluster.
`engineVersion`	string	—	The Redis engine version used by the multi region cluster.
`multiRegionClusterNameSuffix`	string	—	The name of the Multi Region cluster.
`multiRegionParameterGroupName`	string	—	The name of the parameter group associated with the multi region cluster.
`nodeType`	string	yes	The compute and memory capacity of the nodes in the multi region cluster.
`numShards`	integer	—	The number of shards the multi region cluster will contain.
`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 multi region cluster.
`tags[].key`	string	yes
`tags[].value`	string	yes
`tlsEnabled`	boolean	—	A flag that enables in-transit encryption when set to true.
`updateStrategy`	enum	—	An enum string value that determines the update strategy for scaling. Allowed: `COORDINATED, UNCOORDINATED`

Status

Field	Type	Required	Description
`arn`	string	—	The Amazon Resource Name (ARN) of the multi region cluster.
`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	—
`multiRegionClusterName`	string	—	The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
`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 multi region cluster.

MemoryDBParameterGroup # CLOUD CONTROL · AWS::MemoryDB::ParameterGroup

MemoryDBParameterGroup manages AWS::MemoryDB::ParameterGroup through the AWS Cloud Control API.

kubectl get memorydbparametergroups · example on GitHub

Example

# MemoryDBParameterGroup — MemoryDB
# 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/memorydb.html#memorydbparametergroup
apiVersion: aws.konfig.io/v1alpha1
kind: MemoryDBParameterGroup
metadata:
  name: example-memorydbparametergroup
  namespace: default
spec:
  description: Managed by konfig-konector
  family: example
  parameterGroupName: example-memorydbparametergroup
  providerRef:
    name: example-memorydbparametergroup
    region: us-east-1
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`description`	string	—	A description of the parameter group.
`family`	string	yes	The name of the parameter group family that this parameter group is compatible with.
`parameterGroupName`	string	yes	The name of the parameter group.
`parameters`	object	—	An map of parameter names and values for the parameter update.
`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 parameter group.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`arn`	string	—	The Amazon Resource Name (ARN) of the parameter group.
`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.

MemoryDBSubnetGroup # CLOUD CONTROL · AWS::MemoryDB::SubnetGroup

MemoryDBSubnetGroup manages AWS::MemoryDB::SubnetGroup through the AWS Cloud Control API.

kubectl get memorydbsubnetgroups · example on GitHub

Example

# MemoryDBSubnetGroup — MemoryDB
# 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/memorydb.html#memorydbsubnetgroup
apiVersion: aws.konfig.io/v1alpha1
kind: MemoryDBSubnetGroup
metadata:
  name: example-memorydbsubnetgroup
  namespace: default
spec:
  description: Managed by konfig-konector
  providerRef:
    name: example-memorydbsubnetgroup
    region: us-east-1
  subnetGroupName: example-memorydbsubnetgroup
  subnetIds:
  - example
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`description`	string	—	An optional 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	The name of the subnet group.
`subnetIds`	array<string>	yes	A list of VPC subnet IDs for the subnet group.
`tags`	array<object>	—	An array of key-value pairs to apply to this subnet group.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`arn`	string	—	The Amazon Resource Name (ARN) of the subnet group.
`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.
`supportedNetworkTypes`	array<string>	—	Supported network types would be a list of network types supported by subnet group and can be either [ipv4] or [ipv4, dual_stack] or [ipv6].

MemoryDBUser # CLOUD CONTROL · AWS::MemoryDB::User

MemoryDBUser manages AWS::MemoryDB::User through the AWS Cloud Control API.

kubectl get memorydbusers · example on GitHub

Example

# MemoryDBUser — MemoryDB
# 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/memorydb.html#memorydbuser
apiVersion: aws.konfig.io/v1alpha1
kind: MemoryDBUser
metadata:
  name: example-memorydbuser
  namespace: default
spec:
  accessString: example
  authenticationMode:
    passwords:
    - example
    type: password
  providerRef:
    name: example-memorydbuser
    region: us-east-1
  tags:
  - key: example
    value: example
  userName: example-memorydbuser

Spec

Field	Type	Required	Description
`accessString`	string	—	Access permissions string used for this user account.
`authenticationMode`	object	—	MemoryDBUserAuthenticationMode is a nested property type of AWS::MemoryDB::User.
`authenticationMode.passwords`	array<string>	—	Passwords used for this user account.
`authenticationMode.type`	enum	—	Type of authentication strategy for this user. Allowed: `password, iam`
`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
`userName`	string	yes	The name 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.