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

Class UserGroupBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.elasticache.alpha.UserGroupBase

All Implemented Interfaces:

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

Direct Known Subclasses:

UserGroup

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

(experimental) Base class for UserGroup constructs.

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.IUserGroup

IUserGroup.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addUser(IUser _user)	(experimental) Add a user to this user group.
abstract UserEngine	getEngine()	(experimental) The engine type for the user group.
abstract String	getUserGroupArn()	(experimental) The ARN of the user group.
abstract String	getUserGroupName()	(experimental) The name of the user group.
abstract List<IUser>	getUsers()	(experimental) List of users in the user group.

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

UserGroupBase

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

UserGroupBase

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

UserGroupBase

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

UserGroupBase

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

addUser

@Stability(Experimental)
public void addUser(@NotNull
 IUser _user)

(experimental) Add a user to this user group.

Specified by:

addUser in interface IUserGroup

Parameters:

_user - The user to add. This parameter is required.

getUserGroupArn

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

(experimental) The ARN of the user group.

Specified by:

getUserGroupArn in interface IUserGroup

getUserGroupName

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

(experimental) The name of the user group.

Specified by:

getUserGroupName in interface IUserGroup

getEngine

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

(experimental) The engine type for the user group.

Specified by:

getEngine in interface IUserGroup

getUsers

@Stability(Experimental)
@Nullable
public abstract List<IUser> getUsers()

(experimental) List of users in the user group.

Specified by:

getUsers in interface IUserGroup