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

Class UserEngine

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.elasticache.alpha.UserEngine

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.133.0 (build 0f43e37)",
           date="2026-06-16T16:14:49.035Z")
@Stability(Experimental)
public class UserEngine
extends software.amazon.jsii.JsiiObject

(experimental) Engine type for ElastiCache users and user groups.

Use the named static members for the engines currently supported by ElastiCache user/user-group resources. To target an engine not yet represented by a named instance, use UserEngine.of(engineType).

Example:

 IamUser user = IamUser.Builder.create(this, "User")
         // set user engine
         .engine(UserEngine.REDIS)
         // set user id
         .userId("my-user")
         // set username
         .userName("my-user")
         // set access string
         .accessControl(AccessControl.fromAccessString("on ~* +@all"))
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

Modifier and Type	Field	Description
static final UserEngine	REDIS	(experimental) Redis engine.
static final UserEngine	VALKEY	(experimental) Valkey engine.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UserEngine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	UserEngine(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
String	getEngineType()	(experimental) The engine type, for example 'valkey' or 'redis'.
static UserEngine	of(String engineType)	(experimental) Create a new UserEngine with an arbitrary engine type.
String	toString()	(experimental) Returns the engine type as a string (for example, 'valkey').

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

REDIS

@Stability(Experimental)
public static final UserEngine REDIS

(experimental) Redis engine.

VALKEY

@Stability(Experimental)
public static final UserEngine VALKEY

(experimental) Valkey engine.

Constructor Details

UserEngine

protected UserEngine(software.amazon.jsii.JsiiObjectRef objRef)

UserEngine

protected UserEngine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Details

of

@Stability(Experimental)
@NotNull
public static UserEngine of(@NotNull
 String engineType)

(experimental) Create a new UserEngine with an arbitrary engine type.

Parameters:

engineType - the engine type (for example, 'valkey' or 'redis'). This parameter is required.

toString

@Stability(Experimental)
@NotNull
public String toString()

(experimental) Returns the engine type as a string (for example, 'valkey').

Overrides:

toString in class Object

getEngineType

@Stability(Experimental)
@NotNull
public String getEngineType()

(experimental) The engine type, for example 'valkey' or 'redis'.

Maps directly to the Engine property of AWS::ElastiCache::User and AWS::ElastiCache::UserGroup.