UserGroup (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elasticache.model.UserGroup

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UserGroup
extends Object
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

UserGroup()

Constructors
Constructor and Description
`UserGroup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UserGroup`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getARN()` The Amazon Resource Name (ARN) of the user group.
`String`	`getEngine()` The current supported value is Redis.
`String`	`getMinimumEngineVersion()` The minimum engine version required, which is Redis 6.0
`UserGroupPendingChanges`	`getPendingChanges()` A list of updates being applied to the user group.
`List<String>`	`getReplicationGroups()` A list of replication groups that the user group can access.
`List<String>`	`getServerlessCaches()` Indicates which serverless caches the specified user group is associated with.
`String`	`getStatus()` Indicates user group status.
`String`	`getUserGroupId()` The ID of the user group.
`List<String>`	`getUserIds()` The list of user IDs that belong to the user group.
`int`	`hashCode()`
`void`	`setARN(String aRN)` The Amazon Resource Name (ARN) of the user group.
`void`	`setEngine(String engine)` The current supported value is Redis.
`void`	`setMinimumEngineVersion(String minimumEngineVersion)` The minimum engine version required, which is Redis 6.0
`void`	`setPendingChanges(UserGroupPendingChanges pendingChanges)` A list of updates being applied to the user group.
`void`	`setReplicationGroups(Collection<String> replicationGroups)` A list of replication groups that the user group can access.
`void`	`setServerlessCaches(Collection<String> serverlessCaches)` Indicates which serverless caches the specified user group is associated with.
`void`	`setStatus(String status)` Indicates user group status.
`void`	`setUserGroupId(String userGroupId)` The ID of the user group.
`void`	`setUserIds(Collection<String> userIds)` The list of user IDs that belong to the user group.
`String`	`toString()` Returns a string representation of this object.
`UserGroup`	`withARN(String aRN)` The Amazon Resource Name (ARN) of the user group.
`UserGroup`	`withEngine(String engine)` The current supported value is Redis.
`UserGroup`	`withMinimumEngineVersion(String minimumEngineVersion)` The minimum engine version required, which is Redis 6.0
`UserGroup`	`withPendingChanges(UserGroupPendingChanges pendingChanges)` A list of updates being applied to the user group.
`UserGroup`	`withReplicationGroups(Collection<String> replicationGroups)` A list of replication groups that the user group can access.
`UserGroup`	`withReplicationGroups(String... replicationGroups)` A list of replication groups that the user group can access.
`UserGroup`	`withServerlessCaches(Collection<String> serverlessCaches)` Indicates which serverless caches the specified user group is associated with.
`UserGroup`	`withServerlessCaches(String... serverlessCaches)` Indicates which serverless caches the specified user group is associated with.
`UserGroup`	`withStatus(String status)` Indicates user group status.
`UserGroup`	`withUserGroupId(String userGroupId)` The ID of the user group.
`UserGroup`	`withUserIds(Collection<String> userIds)` The list of user IDs that belong to the user group.
`UserGroup`	`withUserIds(String... userIds)` The list of user IDs that belong to the user group.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UserGroup
```
public UserGroup()
```
- Method Detail
  - setUserGroupId
```
public void setUserGroupId(String userGroupId)
```
    The ID of the user group.
    
    Parameters:
    
    userGroupId - The ID of the user group.
  - getUserGroupId
```
public String getUserGroupId()
```
    The ID of the user group.
    
    Returns:
    
    The ID of the user group.
  - withUserGroupId
```
public UserGroup withUserGroupId(String userGroupId)
```
    The ID of the user group.
    
    Parameters:
    
    userGroupId - The ID of the user group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    Indicates user group status. Can be "creating", "active", "modifying", "deleting".
    
    Parameters:
    
    status - Indicates user group status. Can be "creating", "active", "modifying", "deleting".
  - getStatus
```
public String getStatus()
```
    Indicates user group status. Can be "creating", "active", "modifying", "deleting".
    
    Returns:
    
    Indicates user group status. Can be "creating", "active", "modifying", "deleting".
  - withStatus
```
public UserGroup withStatus(String status)
```
    Indicates user group status. Can be "creating", "active", "modifying", "deleting".
    
    Parameters:
    
    status - Indicates user group status. Can be "creating", "active", "modifying", "deleting".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEngine
```
public void setEngine(String engine)
```
    The current supported value is Redis.
    
    Parameters:
    
    engine - The current supported value is Redis.
  - getEngine
```
public String getEngine()
```
    The current supported value is Redis.
    
    Returns:
    
    The current supported value is Redis.
  - withEngine
```
public UserGroup withEngine(String engine)
```
    The current supported value is Redis.
    
    Parameters:
    
    engine - The current supported value is Redis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUserIds
```
public List<String> getUserIds()
```
    The list of user IDs that belong to the user group.
    
    Returns:
    
    The list of user IDs that belong to the user group.
  - setUserIds
```
public void setUserIds(Collection<String> userIds)
```
    The list of user IDs that belong to the user group.
    
    Parameters:
    
    userIds - The list of user IDs that belong to the user group.
  - withUserIds
```
public UserGroup withUserIds(String... userIds)
```
    The list of user IDs that belong to the user group.
    
    NOTE: This method appends the values to the existing list (if any). Use setUserIds(java.util.Collection) or withUserIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    userIds - The list of user IDs that belong to the user group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUserIds
```
public UserGroup withUserIds(Collection<String> userIds)
```
    The list of user IDs that belong to the user group.
    
    Parameters:
    
    userIds - The list of user IDs that belong to the user group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMinimumEngineVersion
```
public void setMinimumEngineVersion(String minimumEngineVersion)
```
    The minimum engine version required, which is Redis 6.0
    
    Parameters:
    
    minimumEngineVersion - The minimum engine version required, which is Redis 6.0
  - getMinimumEngineVersion
```
public String getMinimumEngineVersion()
```
    The minimum engine version required, which is Redis 6.0
    
    Returns:
    
    The minimum engine version required, which is Redis 6.0
  - withMinimumEngineVersion
```
public UserGroup withMinimumEngineVersion(String minimumEngineVersion)
```
    The minimum engine version required, which is Redis 6.0
    
    Parameters:
    
    minimumEngineVersion - The minimum engine version required, which is Redis 6.0
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPendingChanges
```
public void setPendingChanges(UserGroupPendingChanges pendingChanges)
```
    A list of updates being applied to the user group.
    
    Parameters:
    
    pendingChanges - A list of updates being applied to the user group.
  - getPendingChanges
```
public UserGroupPendingChanges getPendingChanges()
```
    A list of updates being applied to the user group.
    
    Returns:
    
    A list of updates being applied to the user group.
  - withPendingChanges
```
public UserGroup withPendingChanges(UserGroupPendingChanges pendingChanges)
```
    A list of updates being applied to the user group.
    
    Parameters:
    
    pendingChanges - A list of updates being applied to the user group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getReplicationGroups
```
public List<String> getReplicationGroups()
```
    A list of replication groups that the user group can access.
    
    Returns:
    
    A list of replication groups that the user group can access.
  - setReplicationGroups
```
public void setReplicationGroups(Collection<String> replicationGroups)
```
    A list of replication groups that the user group can access.
    
    Parameters:
    
    replicationGroups - A list of replication groups that the user group can access.
  - withReplicationGroups
```
public UserGroup withReplicationGroups(String... replicationGroups)
```
    A list of replication groups that the user group can access.
    
    NOTE: This method appends the values to the existing list (if any). Use setReplicationGroups(java.util.Collection) or withReplicationGroups(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    replicationGroups - A list of replication groups that the user group can access.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withReplicationGroups
```
public UserGroup withReplicationGroups(Collection<String> replicationGroups)
```
    A list of replication groups that the user group can access.
    
    Parameters:
    
    replicationGroups - A list of replication groups that the user group can access.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getServerlessCaches
```
public List<String> getServerlessCaches()
```
    Indicates which serverless caches the specified user group is associated with. Available for Redis only.
    
    Returns:
    
    Indicates which serverless caches the specified user group is associated with. Available for Redis only.
  - setServerlessCaches
```
public void setServerlessCaches(Collection<String> serverlessCaches)
```
    Indicates which serverless caches the specified user group is associated with. Available for Redis only.
    
    Parameters:
    
    serverlessCaches - Indicates which serverless caches the specified user group is associated with. Available for Redis only.
  - withServerlessCaches
```
public UserGroup withServerlessCaches(String... serverlessCaches)
```
    Indicates which serverless caches the specified user group is associated with. Available for Redis only.
    
    NOTE: This method appends the values to the existing list (if any). Use setServerlessCaches(java.util.Collection) or withServerlessCaches(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    serverlessCaches - Indicates which serverless caches the specified user group is associated with. Available for Redis only.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withServerlessCaches
```
public UserGroup withServerlessCaches(Collection<String> serverlessCaches)
```
    Indicates which serverless caches the specified user group is associated with. Available for Redis only.
    
    Parameters:
    
    serverlessCaches - Indicates which serverless caches the specified user group is associated with. Available for Redis only.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setARN
```
public void setARN(String aRN)
```
    The Amazon Resource Name (ARN) of the user group.
    
    Parameters:
    
    aRN - The Amazon Resource Name (ARN) of the user group.
  - getARN
```
public String getARN()
```
    The Amazon Resource Name (ARN) of the user group.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the user group.
  - withARN
```
public UserGroup withARN(String aRN)
```
    The Amazon Resource Name (ARN) of the user group.
    
    Parameters:
    
    aRN - The Amazon Resource Name (ARN) of the user group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UserGroup clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.604

Class UserGroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserGroup

Method Detail

setUserGroupId

getUserGroupId

withUserGroupId

setStatus

getStatus

withStatus

setEngine

getEngine

withEngine

getUserIds

setUserIds

withUserIds

withUserIds

setMinimumEngineVersion

getMinimumEngineVersion

withMinimumEngineVersion

setPendingChanges

getPendingChanges

withPendingChanges

getReplicationGroups

setReplicationGroups

withReplicationGroups

withReplicationGroups

getServerlessCaches

setServerlessCaches

withServerlessCaches

withServerlessCaches

setARN

getARN

withARN

toString

equals

hashCode

clone