software.amazon.awssdk.services.docdb.model

Class DBClusterRole

java.lang.Object

software.amazon.awssdk.services.docdb.model.DBClusterRole

All Implemented Interfaces:

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

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

Describes an AWS Identity and Access Management (IAM) role that is associated with a cluster.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DBClusterRole.Builder

Method Summary

Modifier and Type	Method and Description
static DBClusterRole.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	roleArn() The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
List<SdkField<?>>	sdkFields()
static Class<? extends DBClusterRole.Builder>	serializableBuilderClass()
String	status() Describes the state of association between the IAM role and the cluster.
DBClusterRole.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

Returns:

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

status

public final String status()

Describes the state of association between the IAM role and the cluster. The Status property returns one of the following values:

• ACTIVE - The IAM role ARN is associated with the cluster and can be used to access other AWS services on your behalf.

• PENDING - The IAM role ARN is being associated with the DB cluster.

• INVALID - The IAM role ARN is associated with the cluster, but the cluster cannot assume the IAM role to access other AWS services on your behalf.

Returns:

Describes the state of association between the IAM role and the cluster. The Status property returns one of the following values:

• ACTIVE - The IAM role ARN is associated with the cluster and can be used to access other AWS services on your behalf.

• PENDING - The IAM role ARN is being associated with the DB cluster.

• INVALID - The IAM role ARN is associated with the cluster, but the cluster cannot assume the IAM role to access other AWS services on your behalf.

toBuilder

public DBClusterRole.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DBClusterRole.Builder,DBClusterRole>

builder

public static DBClusterRole.Builder builder()

serializableBuilderClass

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