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

Interface PasswordUserProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, UserBaseProps

All Known Implementing Classes:

PasswordUserProps.Jsii$Proxy

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

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

Example:

 PasswordUser user = PasswordUser.Builder.create(this, "User")
         // set user engine
         .engine(UserEngine.VALKEY)
         // set user id
         .userId("my-user-id")
         // set access string
         .accessControl(AccessControl.fromAccessString("on ~* +@all"))
         // set username
         .userName("my-user-name")
         // set up to two passwords
         .passwords(List.of(SecretValue.secretsManager("SecretIdForPassword"), SecretValue.secretsManager("AnotherSecretIdForPassword")))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PasswordUserProps.Builder	builder()
List<SecretValue>	getPasswords()	(experimental) The passwords for the user.
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

getPasswords

@Stability(Experimental)
@NotNull
List<SecretValue> getPasswords()

(experimental) The passwords for the user.

Password authentication requires using 1-2 passwords.

getUserName

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

(experimental) The name of the user.

Default: - Same as userId.

builder

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

Returns:

a PasswordUserProps.Builder of PasswordUserProps