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("software.amazon.awssdk:codegen") public final class CreateUserRequest extends ElastiCacheRequest implements ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateUserRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringaccessString()Access permissions string used for this user.AuthenticationModeauthenticationMode()Specifies how to authenticate the user.static CreateUserRequest.Builderbuilder()Stringengine()The options are valkey or redis.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasPasswords()For responses, this returns true if the service returned a value for the Passwords property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.BooleannoPasswordRequired()Indicates a password is not required for this user.List<String>passwords()Passwords used for this user.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateUserRequest.Builder>serializableBuilderClass()List<Tag>tags()A list of tags to be added to this resource.CreateUserRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringuserId()The ID of the user.StringuserName()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 options are valkey or redis.
- Returns:
- The options are valkey or 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 theisEmpty()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 theisEmpty()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:
toBuilderin interfaceToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>- Specified by:
toBuilderin classElastiCacheRequest
-
builder
public static CreateUserRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateUserRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-