Module Values.UserSource

For Valkey engine version 7.2 onwards and Redis OSS 6.0 to 7.1: Creates a user. For more information, see Using Role Based Access Control (RBAC).

Sourcetype createUserResult = {
  1. userId : String_.t option;
    (*

    The ID of the user.

    *)
  2. userName : String_.t option;
    (*

    The username of the user.

    *)
  3. status : String_.t option;
    (*

    Indicates the user status. Can be "active", "modifying" or "deleting".

    *)
  4. engine : EngineType.t option;
    (*

    The options are valkey or redis.

    *)
  5. minimumEngineVersion : String_.t option;
    (*

    The minimum engine version required, which is Redis OSS 6.0

    *)
  6. accessString : String_.t option;
    (*

    Access permissions string used for this user.

    *)
  7. userGroupIds : UserGroupIdList.t option;
    (*

    Returns a list of the user group IDs the user belongs to.

    *)
  8. authentication : Authentication.t option;
    (*

    Denotes whether the user requires a password to authenticate.

    *)
  9. aRN : String_.t option;
    (*

    The Amazon Resource Name (ARN) of the user.

    *)
}
Sourceand responseMetaData = unit
Sourceand t = {
  1. createUserResult : createUserResult;
  2. responseMetaData : responseMetaData;
}
Sourcetype error = [
  1. | `DuplicateUserNameFault of DuplicateUserNameFault.t
  2. | `InvalidParameterCombinationException of InvalidParameterCombinationException.t
  3. | `InvalidParameterValueException of InvalidParameterValueException.t
  4. | `ServiceLinkedRoleNotFoundFault of ServiceLinkedRoleNotFoundFault.t
  5. | `TagQuotaPerResourceExceeded of TagQuotaPerResourceExceeded.t
  6. | `UserAlreadyExistsFault of UserAlreadyExistsFault.t
  7. | `UserQuotaExceededFault of UserQuotaExceededFault.t
  8. | `Unknown_operation_error of string * string option
]
Sourceval context_ : string
Sourceval make : ?userId:??? -> ?userName:??? -> ?status:??? -> ?engine:??? -> ?minimumEngineVersion:??? -> ?accessString:??? -> ?userGroupIds:??? -> ?authentication:??? -> ?aRN:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `DuplicateUserNameFault of unit | `InvalidParameterCombinationException of InvalidParameterCombinationException.t | `InvalidParameterValueException of InvalidParameterValueException.t | `ServiceLinkedRoleNotFoundFault of unit | `TagQuotaPerResourceExceeded of unit | `Unknown_operation_error of string * string option | `UserAlreadyExistsFault of unit | `UserQuotaExceededFault of unit ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `DuplicateUserNameFault of unit | `InvalidParameterCombinationException of InvalidParameterCombinationException.t | `InvalidParameterValueException of InvalidParameterValueException.t | `ServiceLinkedRoleNotFoundFault of unit | `TagQuotaPerResourceExceeded of unit | `Unknown_operation_error of string * string option | `UserAlreadyExistsFault of unit | `UserQuotaExceededFault of unit ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Structure of (string * [> `List of [> `String of UserGroupId.t ] list | `String of String_.t | `Structure of (string * [> `Enum of string | `Integer of IntegerOptional.t ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t