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

Class UserBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.elasticache.alpha.UserBase

All Implemented Interfaces:

IResource, IUser, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

IamUser, NoPasswordUser, PasswordUser

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-01T17:47:05.838Z")
@Stability(Experimental)
public abstract class UserBase
extends Resource
implements IUser

(experimental) Base class for ElastiCache users.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticache.alpha.*;
 IUser userBase = UserBase.fromUserArn(this, "MyUserBase", "userArn");
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticache.alpha.IUser

IUser.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UserBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	UserBase(software.amazon.jsii.JsiiObjectRef objRef)
protected	UserBase(software.constructs.Construct scope, String id)
protected	UserBase(software.constructs.Construct scope, String id, ResourceProps props)

Method Summary

Modifier and Type	Method	Description
static IUser	fromUserArn(software.constructs.Construct scope, String id, String userArn)	(experimental) Import an existing user by ARN.
static IUser	fromUserAttributes(software.constructs.Construct scope, String id, UserBaseAttributes attrs)	(experimental) Import an existing user using attributes.
static IUser	fromUserId(software.constructs.Construct scope, String id, String userId)	(experimental) Import an existing user by ID.
abstract UserEngine	getEngine()	(experimental) The engine for the user.
abstract String	getUserArn()	(experimental) The user's ARN.
abstract String	getUserId()	(experimental) The user's ID.
abstract String	getUserName()	(experimental) The user's name.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

UserBase

protected UserBase(software.amazon.jsii.JsiiObjectRef objRef)

UserBase

protected UserBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

UserBase

@Stability(Stable)
protected UserBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

UserBase

@Stability(Stable)
protected UserBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

fromUserArn

@Stability(Experimental)
@NotNull
public static IUser fromUserArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String userArn)

(experimental) Import an existing user by ARN.

Parameters:

scope - The parent creating construct (usually this). This parameter is required.

id - The construct's name. This parameter is required.

userArn - The ARN of the existing user. This parameter is required.

fromUserAttributes

@Stability(Experimental)
@NotNull
public static IUser fromUserAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 UserBaseAttributes attrs)

(experimental) Import an existing user using attributes.

Parameters:

scope - The parent creating construct (usually this). This parameter is required.

id - The construct's name. This parameter is required.

attrs - A UserBaseAttributes object. This parameter is required.

fromUserId

@Stability(Experimental)
@NotNull
public static IUser fromUserId(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String userId)

(experimental) Import an existing user by ID.

Parameters:

scope - The parent creating construct (usually this). This parameter is required.

id - The construct's name. This parameter is required.

userId - The ID of the existing user. This parameter is required.

getUserArn

@Stability(Experimental)
@NotNull
public abstract String getUserArn()

(experimental) The user's ARN.

Specified by:

getUserArn in interface IUser

getUserId

@Stability(Experimental)
@NotNull
public abstract String getUserId()

(experimental) The user's ID.

Specified by:

getUserId in interface IUser

getEngine

@Stability(Experimental)
@Nullable
public abstract UserEngine getEngine()

(experimental) The engine for the user.

Specified by:

getEngine in interface IUser

getUserName

@Stability(Experimental)
@Nullable
public abstract String getUserName()

(experimental) The user's name.

Specified by:

getUserName in interface IUser