software.amazon.awssdk.services.elasticache.model

Class CreateUserRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateUserRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	accessString() Access permissions string used for this user.
AuthenticationMode	authenticationMode() Specifies how to authenticate the user.
static CreateUserRequest.Builder	builder()
String	engine() The current supported value is Redis.
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	hasTags() For responses, this returns true if the service returned a value for the Tags property.
Boolean	noPasswordRequired() Indicates a password is not required for this user.
List<String>	passwords() Passwords used for this user.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateUserRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() A list of tags to be added to this resource.
CreateUserRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	userId() The ID of the user.
String	userName() The username 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.

userName

public final String userName()

The username of the user.

Returns:

The username of the user.

engine

public final String engine()

The current supported value is Redis.

Returns:

The current supported value is Redis.

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()

Passwords used for this user. You can create up to two passwords for each user.

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:

Passwords used for this user. You can create up to two passwords for each user.

accessString

public final String accessString()

Access permissions string used for this user.

Returns:

Access permissions string used for this user.

noPasswordRequired

public final Boolean noPasswordRequired()

Indicates a password is not required for this user.

Returns:

Indicates a password is not required for this user.

hasTags

public final boolean hasTags()

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

tags

public final List<Tag> tags()

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

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

Returns:

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

authenticationMode

public final AuthenticationMode authenticationMode()

Specifies how to authenticate the user.

Returns:

Specifies how to authenticate the user.

toBuilder

public CreateUserRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

Specified by:

toBuilder in class ElastiCacheRequest

builder

public static CreateUserRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateUserRequest.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