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

Interface UserGroupAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UserGroupAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:34.226Z")
@Stability(Experimental)
public interface UserGroupAttributes
extends software.amazon.jsii.JsiiSerializable

(experimental) Attributes that can be specified when importing a UserGroup.

Example:

 Stack stack = new Stack();
 IUser importedIamUser = IamUser.fromUserId(this, "ImportedIamUser", "my-iam-user-id");
 IUser importedPasswordUser = PasswordUser.fromUserAttributes(stack, "ImportedPasswordUser", UserBaseAttributes.builder()
         .userId("my-password-user-id")
         .build());
 IUser importedNoPasswordUser = NoPasswordUser.fromUserAttributes(stack, "ImportedNoPasswordUser", UserBaseAttributes.builder()
         .userId("my-no-password-user-id")
         .build());
 IUserGroup importedUserGroup = UserGroup.fromUserGroupAttributes(this, "ImportedUserGroup", UserGroupAttributes.builder()
         .userGroupName("my-user-group-name")
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static UserGroupAttributes.Builder	builder()
default UserEngine	getEngine()	(experimental) The engine type for the user group.
default String	getUserGroupArn()	(experimental) The ARN of the user group.
default String	getUserGroupName()	(experimental) The name of the user group.
default List<IUser>	getUsers()	(experimental) List of users in the user group.

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

Default: - engine type is unknown

getUserGroupArn

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

(experimental) The ARN of the user group.

One of userGroupName or userGroupArn is required.

Default: - derived from userGroupName

getUserGroupName

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

(experimental) The name of the user group.

One of userGroupName or userGroupArn is required.

Default: - derived from userGroupArn

getUsers

@Stability(Experimental)
@Nullable
default List<IUser> getUsers()

(experimental) List of users in the user group.

Default: - users are unknown

builder

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

Returns:

a UserGroupAttributes.Builder of UserGroupAttributes