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.

UserBaseAttributes Struct ​

Attributes for importing an existing ElastiCache user.

Example ​

ts
// use the original `default` user by using import method
const defaultUser = elasticache.NoPasswordUser.fromUserAttributes(this, 'DefaultUser', {
  // userId and userName must be 'default'
  userId: 'default',
});

// create a new default user
const newDefaultUser = new elasticache.NoPasswordUser(this, 'NewDefaultUser', {
  // new default user id must not be 'default'
  userId: 'new-default',
  // new default username must be 'default'
  userName: 'default',
  // set access string
  accessControl: elasticache.AccessControl.fromAccessString("on ~* +@all"),
});

Properties ​

engineoptionalUserEngineengineoptionalUserEngineengineoptionalUserEngineEngineoptionalUserEngineEngineoptionalUserEngine#
The engine type for the user.

Default: engine type is unknown.

userArnoptionalstringuser_arnoptionalstruserArnoptionalStringUserArnoptionalstringUserArnoptional*string#
The ARN of the user.

Default: derived from userId.

One of userId or userArn is required.

userIdoptionalstringuser_idoptionalstruserIdoptionalStringUserIdoptionalstringUserIdoptional*string#
The ID of the user.

Default: derived from userArn.

One of userId or userArn is required.

userNameoptionalstringuser_nameoptionalstruserNameoptionalStringUserNameoptionalstringUserNameoptional*string#
The user's name.

Default: name is unknown.