UserEngine

class aws_cdk.aws_elasticache_alpha.UserEngine(*args: Any, **kwargs)

Bases: object

(experimental) 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).

Stability:: experimental
ExampleMetadata:: infused

Example:

user = elasticache.IamUser(self, "User",
    # set user engine
    engine=elasticache.UserEngine.REDIS,

    # set user id
    user_id="my-user",

    # set username
    user_name="my-user",

    # set access string
    access_control=elasticache.AccessControl.from_access_string("on ~* +@all")
)

Methods

to_string()

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

Stability:: experimental
Return type:: str

Attributes

REDIS = <aws_cdk.aws_elasticache_alpha.UserEngine object>

VALKEY = <aws_cdk.aws_elasticache_alpha.UserEngine object>

engine_type

(experimental) The engine type, for example 'valkey' or 'redis'.

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

Stability:: experimental

Static Methods

classmethod of(engine_type)

(experimental) Create a new UserEngine with an arbitrary engine type.

Parameters:: engine_type (str) – the engine type (for example, 'valkey' or 'redis').
Stability:: experimental
Return type:: UserEngine