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

Experimental

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

IamUserProps Struct

Properties for defining an ElastiCache user with IAM authentication.

IamUserProps

extends

• UserBaseProps

Stability

Experimental

Source

lib/iam-user.ts

Example

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

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

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

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

Properties

accessControlAccessControlaccess_controlAccessControlaccessControlAccessControlAccessControlAccessControlAccessControlAccessControlrequired#

Access control configuration for the user.

engineUserEngineengineUserEngineengineUserEngineEngineUserEngineEngineUserEngine= UserEngine.REDIS for NoPasswordU…#

The engine type for the user.

Enum options: UserEngine.VALKEY, UserEngine.REDIS.

default

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

userIdstringuser_idstruserIdStringUserIdstringUserId*stringrequired#

The ID of the user.

userNamestringuser_namestruserNameStringUserNamestringUserName*string= Same as userId.#

The name of the user.

Used as props by

• IamUser