Module Values.UserGroupSource

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

Sourcetype createUserGroupResult = {
  1. userGroupId : String_.t option;
    (*

    The ID of the user group.

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

    Indicates user group status. Can be "creating", "active", "modifying", "deleting".

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

    The options are valkey or redis.

    *)
  4. userIds : UserIdList.t option;
    (*

    The list of user IDs that belong to the user group.

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

    The minimum engine version required, which is Redis OSS 6.0

    *)
  6. pendingChanges : UserGroupPendingChanges.t option;
    (*

    A list of updates being applied to the user group.

    *)
  7. replicationGroups : UGReplicationGroupIdList.t option;
    (*

    A list of replication groups that the user group can access.

    *)
  8. serverlessCaches : UGServerlessCacheIdList.t option;
    (*

    Indicates which serverless caches the specified user group is associated with. Available for Valkey, Redis OSS and Serverless Memcached only.

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

    The Amazon Resource Name (ARN) of the user group.

    *)
}
Sourceand responseMetaData = unit
Sourceand t = {
  1. createUserGroupResult : createUserGroupResult;
  2. responseMetaData : responseMetaData;
}
Sourcetype error = [
  1. | `DefaultUserRequired of DefaultUserRequired.t
  2. | `DuplicateUserNameFault of DuplicateUserNameFault.t
  3. | `InvalidParameterValueException of InvalidParameterValueException.t
  4. | `ServiceLinkedRoleNotFoundFault of ServiceLinkedRoleNotFoundFault.t
  5. | `TagQuotaPerResourceExceeded of TagQuotaPerResourceExceeded.t
  6. | `UserGroupAlreadyExistsFault of UserGroupAlreadyExistsFault.t
  7. | `UserGroupQuotaExceededFault of UserGroupQuotaExceededFault.t
  8. | `UserNotFoundFault of UserNotFoundFault.t
  9. | `Unknown_operation_error of string * string option
]
Sourceval context_ : string
Sourceval make : ?userGroupId:??? -> ?status:??? -> ?engine:??? -> ?userIds:??? -> ?minimumEngineVersion:??? -> ?pendingChanges:??? -> ?replicationGroups:??? -> ?serverlessCaches:??? -> ?aRN:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `DefaultUserRequired of unit | `DuplicateUserNameFault of unit | `InvalidParameterValueException of InvalidParameterValueException.t | `ServiceLinkedRoleNotFoundFault of unit | `TagQuotaPerResourceExceeded of unit | `Unknown_operation_error of string * string option | `UserGroupAlreadyExistsFault of unit | `UserGroupQuotaExceededFault of unit | `UserNotFoundFault of unit ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `DefaultUserRequired of unit | `DuplicateUserNameFault of unit | `InvalidParameterValueException of InvalidParameterValueException.t | `ServiceLinkedRoleNotFoundFault of unit | `TagQuotaPerResourceExceeded of unit | `Unknown_operation_error of string * string option | `UserGroupAlreadyExistsFault of unit | `UserGroupQuotaExceededFault of unit | `UserNotFoundFault of unit ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Structure of (string * [> `List of [> `String of UserId.t ] list | `String of String_.t | `Structure of (string * [> `List of [> `String of UserId.t ] list ]) 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