Package software.amazon.awscdk.services.elasticache.alpha

Interface UserBaseAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UserBaseAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-01T17:47:05.838Z")
@Stability(Experimental)
public interface UserBaseAttributes
extends software.amazon.jsii.JsiiSerializable

(experimental) Attributes for importing an existing ElastiCache user.

Example:

 // use the original `default` user by using import method
 IUser defaultUser = NoPasswordUser.fromUserAttributes(this, "DefaultUser", UserBaseAttributes.builder()
         // userId and userName must be 'default'
         .userId("default")
         .build());
 // create a new default user
 NoPasswordUser newDefaultUser = NoPasswordUser.Builder.create(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(AccessControl.fromAccessString("on ~* +@all"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	UserBaseAttributes.Builder	A builder for UserBaseAttributes
static final class	UserBaseAttributes.Jsii$Proxy	An implementation for UserBaseAttributes

Method Summary

Modifier and Type	Method	Description
static UserBaseAttributes.Builder	builder()
default UserEngine	getEngine()	(experimental) The engine type for the user.
default String	getUserArn()	(experimental) The ARN of the user.
default String	getUserId()	(experimental) The ID of the user.
default String	getUserName()	(experimental) The user's name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEngine

@Stability(Experimental)
@Nullable
default UserEngine getEngine()

(experimental) The engine type for the user.

Default: - engine type is unknown.

getUserArn

@Stability(Experimental)
@Nullable
default String getUserArn()

(experimental) The ARN of the user.

One of userId or userArn is required.

Default: - derived from userId.

getUserId

@Stability(Experimental)
@Nullable
default String getUserId()

(experimental) The ID of the user.

One of userId or userArn is required.

Default: - derived from userArn.

getUserName

@Stability(Experimental)
@Nullable
default String getUserName()

(experimental) The user's name.

Default: - name is unknown.

builder

@Stability(Experimental)
static UserBaseAttributes.Builder builder()

Returns:

a UserBaseAttributes.Builder of UserBaseAttributes