@aws-cdk/aws-elasticache-alpha.PasswordUserProps

Experimental

@aws-cdk/aws-elasticache-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

PasswordUserProps Struct

Properties for defining an ElastiCache user with password authentication.

PasswordUserProps

extends

• UserBaseProps

used as props by

• PasswordUser

Stability

Experimental

Source

lib/password-user.ts

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

accessControlAccessControlaccess_controlAccessControlaccessControlAccessControlAccessControlAccessControlAccessControlAccessControlrequired#

Access control configuration for the user.

engineUserEngineengineUserEngineengineUserEngineEngineUserEngineEngineUserEngine#

The engine type for the user.

Default: UserEngine.REDIS for NoPasswordUser, UserEngine.VALKEY for all other user types.

Enum options: UserEngine.VALKEY, UserEngine.REDIS.

passwordsSecretValue[]passwordstyping.List[SecretValue]passwordsList<SecretValue>PasswordsSecretValue[]Passwords*[]SecretValuerequired#

The passwords for the user.

Password authentication requires using 1-2 passwords.

userIdstringuser_idstruserIdStringUserIdstringUserId*stringrequired#

The ID of the user.

userNamestringuser_namestruserNameStringUserNamestringUserName*string#

The name of the user.

Default: Same as userId.