class UserEngine 🔹

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

Engine type for ElastiCache users and user groups.

Use the named static members for the engines currently supported by ElastiCache user/user-group resources. To target an engine not yet represented by a named instance, use UserEngine.of(engineType).

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

Name	Type	Description
engineType🔹	`string`	The engine type, for example `'valkey'` or `'redis'`.
static REDIS🔹	`UserEngine`	Redis engine.
static VALKEY🔹	`UserEngine`	Valkey engine.

engineType🔹

Type: string

The engine type, for example 'valkey' or 'redis'.

Maps directly to the Engine property of AWS::ElastiCache::User and AWS::ElastiCache::UserGroup.

static REDIS🔹

Type: UserEngine

Redis engine.

static VALKEY🔹

Type: UserEngine

Valkey engine.

Methods

Name	Description
toString()🔹	Returns the engine type as a string (for example, `'valkey'`).
static of(engineType)🔹	Create a new `UserEngine` with an arbitrary engine type.

toString()🔹

public toString(): string

Returns

string

Returns the engine type as a string (for example, 'valkey').

static of(engineType)🔹

public static of(engineType: string): UserEngine

Parameters

engineType string — the engine type (for example, 'valkey' or 'redis').