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

Class PasswordUser

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.elasticache.alpha.UserBase

software.amazon.awscdk.services.elasticache.alpha.PasswordUser

All Implemented Interfaces:

IResource, IUser, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-01T17:47:05.833Z")
@Stability(Experimental)
public class PasswordUser
extends UserBase

(experimental) Define 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	Class	Description
static final class	PasswordUser.Builder	(experimental) A fluent builder for PasswordUser.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticache.alpha.IUser

IUser.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	(experimental) Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PasswordUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	PasswordUser(software.amazon.jsii.JsiiObjectRef objRef)
	PasswordUser(software.constructs.Construct scope, String id, PasswordUserProps props)

Method Summary

Modifier and Type	Method	Description
String	getAccessString()	(experimental) The access string that defines the user's permissions.
UserEngine	getEngine()	(experimental) The engine for the user.
String	getUserArn()	(experimental) The user's ARN.
String	getUserId()	(experimental) The user's ID.
String	getUserName()	(experimental) The user's name.
String	getUserStatus()	(experimental) The user's status.
static Boolean	isPasswordUser(Object x)	(experimental) Return whether the given object is a PasswordUser.

Methods inherited from class software.amazon.awscdk.services.elasticache.alpha.UserBase

fromUserArn, fromUserAttributes, fromUserId

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Experimental)
public static final String PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

Constructor Details

PasswordUser

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

PasswordUser

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

PasswordUser

@Stability(Experimental)
public PasswordUser(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 PasswordUserProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

isPasswordUser

@Stability(Experimental)
@NotNull
public static Boolean isPasswordUser(@NotNull
 Object x)

(experimental) Return whether the given object is a PasswordUser.

Parameters:

x - This parameter is required.

getAccessString

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

(experimental) The access string that defines the user's permissions.

getUserArn

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

(experimental) The user's ARN.

Specified by:

getUserArn in interface IUser

Specified by:

getUserArn in class UserBase

getUserId

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

(experimental) The user's ID.

Specified by:

getUserId in interface IUser

Specified by:

getUserId in class UserBase

getUserStatus

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

(experimental) The user's status.

Can be 'active', 'modifying', 'deleting'.

getEngine

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

(experimental) The engine for the user.

Specified by:

getEngine in interface IUser

Specified by:

getEngine in class UserBase

getUserName

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

(experimental) The user's name.

Specified by:

getUserName in interface IUser

Specified by:

getUserName in class UserBase