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

Interface UserBaseProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IamUserProps, NoPasswordUserProps, PasswordUserProps

All Known Implementing Classes:

IamUserProps.Jsii$Proxy, NoPasswordUserProps.Jsii$Proxy, PasswordUserProps.Jsii$Proxy, UserBaseProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:51.594Z")
@Stability(Experimental)
public interface UserBaseProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for defining an ElastiCache base user.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticache.alpha.*;
 AccessControl accessControl;
 UserBaseProps userBaseProps = UserBaseProps.builder()
         .accessControl(accessControl)
         .userId("userId")
         // the properties below are optional
         .engine(UserEngine.VALKEY)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static UserBaseProps.Builder	builder()
AccessControl	getAccessControl()	(experimental) Access control configuration for the user.
default UserEngine	getEngine()	(experimental) The engine type for the user.
String	getUserId()	(experimental) The ID of the user.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessControl

@Stability(Experimental)
@NotNull
AccessControl getAccessControl()

(experimental) Access control configuration for the user.

getUserId

@Stability(Experimental)
@NotNull
String getUserId()

(experimental) The ID of the user.

getEngine

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

(experimental) The engine type for the user.

Enum options: UserEngine.VALKEY, UserEngine.REDIS.

Default: UserEngine.VALKEY.

builder

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

Returns:

a UserBaseProps.Builder of UserBaseProps