software.amazon.awssdk.services.memorydb.model

Class ACL

java.lang.Object

software.amazon.awssdk.services.memorydb.model.ACL

All Implemented Interfaces:

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

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

An Access Control List. You can authenticate users with Access Contol Lists. ACLs enable you to control cluster access by grouping users. These Access control lists are designed as a way to organize access to clusters.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ACL.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) of the ACL
static ACL.Builder	builder()
List<String>	clusters() A list of clusters associated with the ACL.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasClusters() For responses, this returns true if the service returned a value for the Clusters property.
int	hashCode()
boolean	hasUserNames() For responses, this returns true if the service returned a value for the UserNames property.
String	minimumEngineVersion() The minimum engine version supported for the ACL
String	name() The name of the Access Control List
ACLPendingChanges	pendingChanges() A list of updates being applied to the ACL.
List<SdkField<?>>	sdkFields()
static Class<? extends ACL.Builder>	serializableBuilderClass()
String	status() Indicates ACL status.
ACL.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	userNames() The list of user names that belong to the ACL.

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 Access Control List

Returns:

The name of the Access Control List

status

public final String status()

Indicates ACL status. Can be "creating", "active", "modifying", "deleting".

Returns:

Indicates ACL status. Can be "creating", "active", "modifying", "deleting".

hasUserNames

public final boolean hasUserNames()

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

userNames

public final List<String> userNames()

The list of user names that belong to the ACL.

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

Returns:

The list of user names that belong to the ACL.

minimumEngineVersion

public final String minimumEngineVersion()

The minimum engine version supported for the ACL

Returns:

The minimum engine version supported for the ACL

pendingChanges

public final ACLPendingChanges pendingChanges()

A list of updates being applied to the ACL.

Returns:

A list of updates being applied to the ACL.

hasClusters

public final boolean hasClusters()

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

clusters

public final List<String> clusters()

A list of clusters associated with the ACL.

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

Returns:

A list of clusters associated with the ACL.

arn

public final String arn()

The Amazon Resource Name (ARN) of the ACL

Returns:

The Amazon Resource Name (ARN) of the ACL

toBuilder

public ACL.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ACL.Builder,ACL>

builder

public static ACL.Builder builder()

serializableBuilderClass

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