Skip to content
v2.274.0

Experimental

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

UserBaseProps Struct ​

Properties for defining an ElastiCache base user.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as elasticache_alpha from '@aws-cdk/aws-elasticache-alpha';

declare const accessControl: elasticache_alpha.AccessControl;
declare const userEngine: elasticache_alpha.UserEngine;
const userBaseProps: elasticache_alpha.UserBaseProps = {
  accessControl: accessControl,
  userId: 'userId',

  // the properties below are optional
  engine: userEngine,
};

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.