User

memorydb.services.k8s.aws/v1alpha1

TypeLink
GoDocmemorydb-controller/apis/v1alpha1#User

Metadata

PropertyValue
ScopeNamespaced
KindUser
ListKindUserList
Pluralusers
Singularuser

You create users and assign them specific permissions by using an access string. You assign the users to Access Control Lists aligned with a specific role (administrators, human resources) that are then deployed to one or more MemoryDB clusters.

Spec

accessString: string
authenticationMode: 
  passwords:
  - key: string
    name: string
    namespace: string
  type_: string
name: string
tags:
- key: string
  value: string
FieldDescription
accessString
Required
string
Access permissions string used for this user.
authenticationMode
Required
object
Denotes the user’s authentication properties, such as whether it requires a password to authenticate.
authenticationMode.passwords
Optional
array
authenticationMode.passwords.[]
Required
object
SecretKeyReference combines a k8s corev1.SecretReference with a specific key within the referred-to Secret
authenticationMode.passwords.[].name
Optional
string
name is unique within a namespace to reference a secret resource.
authenticationMode.passwords.[].namespace
Optional
string
namespace defines the space within which the secret name must be unique.
**authenticationMode.type_**
Optional
string
name
Required
string
The name of the user. This value must be unique as it also serves as the user identifier.
tags
Optional
array
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
tags.[]
Required
object
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources (https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging-resources.html)
tags.[].value
Optional
string

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
aclNames:
- string
authentication: 
  passwordCount: integer
  type_: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
events:
- date: string
  message: string
  sourceName: string
  sourceType: string
minimumEngineVersion: string
status: string
FieldDescription
ackResourceMetadata
Optional
object
All CRs managed by ACK have a common Status.ACKResourceMetadata member that is used to contain resource sync state, account ownership, constructed ARN for the resource
ackResourceMetadata.arn
Optional
string
ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID
Required
string
OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.
ackResourceMetadata.region
Required
string
Region is the AWS region in which the resource exists or will exist.
aclNames
Optional
array
The names of the Access Control Lists to which the user belongs
aclNames.[]
Required
string
authentication.passwordCount
Optional
integer
**authentication.type_**
Optional
string
conditions
Optional
array
All CRS managed by ACK have a common Status.Conditions member that contains a collection of ackv1alpha1.Condition objects that describe the various terminal states of the CR and its backend AWS service API resource
conditions.[]
Required
object
Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource
conditions.[].message
Optional
string
A human readable message indicating details about the transition.
conditions.[].reason
Optional
string
The reason for the condition’s last transition.
conditions.[].status
Optional
string
Status of the condition, one of True, False, Unknown.
conditions.[].type
Optional
string
Type is the type of the Condition
events
Optional
array
A list of events. Each element in the list contains detailed information about one event.
events.[]
Required
object
Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster or adding or removing a node.
events.[].message
Optional
string
events.[].sourceName
Optional
string
events.[].sourceType
Optional
string
minimumEngineVersion
Optional
string
The minimum engine version supported for the user
status
Optional
string
Indicates the user status. Can be “active”, “modifying” or “deleting”.