All Superinterfaces:
software.constructs.IConstruct, software.constructs.IDependable, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IUserGroup.Jsii$Default
All Known Implementing Classes:
IUserGroup.Jsii$Proxy, UserGroup, UserGroupBase

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-10-01T17:47:05.830Z") @Stability(Experimental) public interface IUserGroup extends software.amazon.jsii.JsiiSerializable, IResource
(experimental) Represents an ElastiCache UserGroup.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Internal default implementation for IUserGroup.
    static final class 
    A proxy class which represents a concrete javascript instance of this type.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addUser(IUser user)
    (experimental) Add a user to this user group.
    default UserEngine
    (experimental) The engine type for the user group.
    (experimental) The ARN of the user group.
    (experimental) The name of the user group.
    default List<IUser>
    (experimental) List of users in the user group.

    Methods inherited from interface software.constructs.IConstruct

    getNode

    Methods inherited from interface software.amazon.awscdk.IResource

    applyRemovalPolicy, getEnv, getStack

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson
  • Method Details

    • getUserGroupArn

      @Stability(Experimental) @NotNull String getUserGroupArn()
      (experimental) The ARN of the user group.
    • getUserGroupName

      @Stability(Experimental) @NotNull String getUserGroupName()
      (experimental) The name of the user group.
    • getEngine

      @Stability(Experimental) @Nullable default UserEngine getEngine()
      (experimental) The engine type for the user group.
    • getUsers

      @Stability(Experimental) @Nullable default List<IUser> getUsers()
      (experimental) List of users in the user group.
    • addUser

      @Stability(Experimental) void addUser(@NotNull IUser user)
      (experimental) Add a user to this user group.

      Parameters:
      user - The user to add. This parameter is required.