PasswordUserProps

class aws_cdk.aws_elasticache_alpha.PasswordUserProps(*, access_control, user_id, engine=None, passwords, user_name=None)

Bases: UserBaseProps

(experimental) Properties for defining an ElastiCache user with password authentication.

Parameters:
  • access_control (AccessControl) – (experimental) Access control configuration for the user.

  • user_id (str) – (experimental) The ID of the user.

  • engine (Optional[UserEngine]) – (experimental) The engine type for the user. Enum options: UserEngine.VALKEY, UserEngine.REDIS. Default: UserEngine.VALKEY.

  • passwords (Sequence[SecretValue]) – (experimental) The passwords for the user. Password authentication requires using 1-2 passwords.

  • user_name (Optional[str]) – (experimental) The name of the user. Default: - Same as userId.

Stability:

experimental

ExampleMetadata:

infused

Example:

user = elasticache.PasswordUser(self, "User",
    # set user engine
    engine=elasticache.UserEngine.VALKEY,

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

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

    # set username
    user_name="my-user-name",

    # set up to two passwords
    passwords=[
        # "SecretIdForPassword" is the secret id for the password
        SecretValue.secrets_manager("SecretIdForPassword"),
        # "AnotherSecretIdForPassword" is the secret id for the password
        SecretValue.secrets_manager("AnotherSecretIdForPassword")
    ]
)

Attributes

access_control

(experimental) Access control configuration for the user.

Stability:

experimental

engine

(experimental) The engine type for the user.

Enum options: UserEngine.VALKEY, UserEngine.REDIS.

Default:

UserEngine.VALKEY.

Stability:

experimental

passwords

(experimental) The passwords for the user.

Password authentication requires using 1-2 passwords.

Stability:

experimental

user_id

(experimental) The ID of the user.

Stability:

experimental

user_name

(experimental) The name of the user.

Default:
  • Same as userId.

Stability:

experimental