Package software.amazon.awscdk.services.elasticache.alpha

Interface UserGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UserGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-29T12:38:21.190Z")
@Stability(Experimental)
public interface UserGroupProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for defining an ElastiCache UserGroup.

Example:

 NoPasswordUser newDefaultUser = NoPasswordUser.Builder.create(this, "NoPasswordUser")
         .userId("default")
         .accessControl(AccessControl.fromAccessString("on ~* +@all"))
         .build();
 UserGroup userGroup = UserGroup.Builder.create(this, "UserGroup")
         .users(List.of(newDefaultUser))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	UserGroupProps.Builder	A builder for UserGroupProps
static final class	UserGroupProps.Jsii$Proxy	An implementation for UserGroupProps

Method Summary

Modifier and Type	Method	Description
static UserGroupProps.Builder	builder()
default UserEngine	getEngine()	(experimental) The engine type for the user group Enum options: UserEngine.VALKEY, UserEngine.REDIS.
default String	getUserGroupName()	(experimental) Enforces a particular physical user group name.
default List<IUser>	getUsers()	(experimental) List of users inside the user group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEngine

@Stability(Experimental)
@Nullable
default UserEngine getEngine()

(experimental) The engine type for the user group Enum options: UserEngine.VALKEY, UserEngine.REDIS.

Default: UserEngine.VALKEY

getUserGroupName

@Stability(Experimental)
@Nullable
default String getUserGroupName()

(experimental) Enforces a particular physical user group name.

Default:

getUsers

@Stability(Experimental)
@Nullable
default List<IUser> getUsers()

(experimental) List of users inside the user group.

Default: - no users

builder

@Stability(Experimental)
static UserGroupProps.Builder builder()

Returns:

a UserGroupProps.Builder of UserGroupProps