interface PasswordUserProps 🔹

Language	Type name
.NET	Amazon.CDK.AWS.ElastiCache.Alpha.PasswordUserProps
Go	github.com/aws/aws-cdk-go/awscdkelasticachealpha/v2#PasswordUserProps
Java	software.amazon.awscdk.services.elasticache.alpha.PasswordUserProps
Python	aws_cdk.aws_elasticache_alpha.PasswordUserProps
TypeScript (source)	@aws-cdk/aws-elasticache-alpha » PasswordUserProps

Properties for defining an ElastiCache user with password authentication.

Example

const user = new elasticache.PasswordUser(this, 'User', {
  // set user engine
  engine: elasticache.UserEngine.VALKEY,

  // set user id
  userId: 'my-user-id',

  // set access string
  accessControl: elasticache.AccessControl.fromAccessString("on ~* +@all"),

  // set username
  userName: 'my-user-name',

  // set up to two passwords
  passwords: [
    // "SecretIdForPassword" is the secret id for the password
    SecretValue.secretsManager('SecretIdForPassword'),
    // "AnotherSecretIdForPassword" is the secret id for the password
    SecretValue.secretsManager('AnotherSecretIdForPassword'),
  ],
});

Properties

Name	Type	Description
accessControl🔹	AccessControl	Access control configuration for the user.
passwords🔹	SecretValue[]	The passwords for the user.
userId🔹	string	The ID of the user.
engine?🔹	UserEngine	The engine type for the user.
userName?🔹	string	The name of the user.

---

accessControl🔹

Type: AccessControl

Access control configuration for the user.

---

passwords🔹

Type: SecretValue[]

The passwords for the user.

Password authentication requires using 1-2 passwords.

---

userId🔹

Type: string

The ID of the user.

---

engine?🔹

Type: UserEngine (optional, default: UserEngine.VALKEY.)

The engine type for the user.

Enum options: UserEngine.VALKEY, UserEngine.REDIS.

---

userName?🔹

Type: string (optional, default: Same as userId.)

The name of the user.