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

Interface IamUserProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, UserBaseProps

All Known Implementing Classes:

IamUserProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-01T17:47:05.832Z")
@Stability(Experimental)
public interface IamUserProps
extends software.amazon.jsii.JsiiSerializable, UserBaseProps

(experimental) Properties for defining an ElastiCache user with IAM authentication.

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

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

Method Summary

Modifier and Type	Method	Description
static IamUserProps.Builder	builder()
default String	getUserName()	(experimental) The name of the user.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.elasticache.alpha.UserBaseProps

getAccessControl, getEngine, getUserId

Method Details

getUserName

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

(experimental) The name of the user.

Default: - Same as userId.

builder

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

Returns:

a IamUserProps.Builder of IamUserProps