Package software.amazon.awssdk.services.elasticache.model

Class ModifyUserRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.elasticache.model.ElastiCacheRequest

software.amazon.awssdk.services.elasticache.model.ModifyUserRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ModifyUserRequest.Builder,ModifyUserRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ModifyUserRequest
extends ElastiCacheRequest
implements ToCopyableBuilder<ModifyUserRequest.Builder,ModifyUserRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ModifyUserRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	accessString()	Access permissions string used for this user.
String	appendAccessString()	Adds additional user permissions to the access string.
AuthenticationMode	authenticationMode()	Specifies how to authenticate the user.
static ModifyUserRequest.Builder	builder()
String	engine()	Modifies the engine listed for a user.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPasswords()	For responses, this returns true if the service returned a value for the Passwords property.
Boolean	noPasswordRequired()	Indicates no password is required for the user.
List<String>	passwords()	The passwords belonging to the user.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ModifyUserRequest.Builder>	serializableBuilderClass()
ModifyUserRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userId()	The ID of the user.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

userId

public final String userId()

The ID of the user.

Returns:

The ID of the user.

accessString

public final String accessString()

Access permissions string used for this user.

Returns:

Access permissions string used for this user.

appendAccessString

public final String appendAccessString()

Adds additional user permissions to the access string.

Returns:

Adds additional user permissions to the access string.

hasPasswords

public final boolean hasPasswords()

For responses, this returns true if the service returned a value for the Passwords 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.

passwords

public final List<String> passwords()

The passwords belonging to the user. You are allowed up to two.

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 hasPasswords() method.

Returns:

The passwords belonging to the user. You are allowed up to two.

noPasswordRequired

public final Boolean noPasswordRequired()

Indicates no password is required for the user.

Returns:

Indicates no password is required for the user.

authenticationMode

public final AuthenticationMode authenticationMode()

Specifies how to authenticate the user.

Returns:

Specifies how to authenticate the user.

engine

public final String engine()

Modifies the engine listed for a user. The options are valkey or redis.

Returns:

Modifies the engine listed for a user. The options are valkey or redis.

toBuilder

public ModifyUserRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyUserRequest.Builder,ModifyUserRequest>

Specified by:

toBuilder in class ElastiCacheRequest

builder

public static ModifyUserRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo