software.amazon.awssdk.services.memorydb.model

Class User

java.lang.Object

software.amazon.awssdk.services.memorydb.model.User

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<User.Builder,User>

@Generated(value="software.amazon.awssdk:codegen")
public final class User
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<User.Builder,User>

You create users and assign them specific permissions by using an access string. You assign the users to Access Control Lists aligned with a specific role (administrators, human resources) that are then deployed to one or more MemoryDB clusters.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	User.Builder

Method Summary

Modifier and Type	Method and Description
String	accessString() Access permissions string used for this user.
List<String>	aclNames() The names of the Access Control Lists to which the user belongs
String	arn() The Amazon Resource Name (ARN) of the user.
Authentication	authentication() Denotes whether the user requires a password to authenticate.
static User.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAclNames() For responses, this returns true if the service returned a value for the ACLNames property.
int	hashCode()
String	minimumEngineVersion() The minimum engine version supported for the user
String	name() The name of the user
List<SdkField<?>>	sdkFields()
static Class<? extends User.Builder>	serializableBuilderClass()
String	status() Indicates the user status.
User.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name of the user

Returns:

The name of the user

status

public final String status()

Indicates the user status. Can be "active", "modifying" or "deleting".

Returns:

Indicates the user status. Can be "active", "modifying" or "deleting".

accessString

public final String accessString()

Access permissions string used for this user.

Returns:

Access permissions string used for this user.

hasAclNames

public final boolean hasAclNames()

For responses, this returns true if the service returned a value for the ACLNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

aclNames

public final List<String> aclNames()

The names of the Access Control Lists to which the user belongs

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAclNames() method.

Returns:

The names of the Access Control Lists to which the user belongs

minimumEngineVersion

public final String minimumEngineVersion()

The minimum engine version supported for the user

Returns:

The minimum engine version supported for the user

authentication

public final Authentication authentication()

Denotes whether the user requires a password to authenticate.

Returns:

Denotes whether the user requires a password to authenticate.

arn

public final String arn()

The Amazon Resource Name (ARN) of the user.

Returns:

The Amazon Resource Name (ARN) of the user.

toBuilder

public User.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<User.Builder,User>

builder

public static User.Builder builder()

serializableBuilderClass

public static Class<? extends User.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo