Package software.amazon.awssdk.services.docdb.model

Class GlobalCluster

java.lang.Object

software.amazon.awssdk.services.docdb.model.GlobalCluster

All Implemented Interfaces:

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

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

A data type representing an Amazon DocumentDB global cluster.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GlobalCluster.Builder

Method Summary

Modifier and Type	Method	Description
static GlobalCluster.Builder	builder()
String	databaseName()	The default database name within the new global cluster.
Boolean	deletionProtection()	The deletion protection setting for the new global cluster.
String	engine()	The Amazon DocumentDB database engine used by the global cluster.
String	engineVersion()	Indicates the database engine version.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	globalClusterArn()	The Amazon Resource Name (ARN) for the global cluster.
String	globalClusterIdentifier()	Contains a user-supplied global cluster identifier.
List<GlobalClusterMember>	globalClusterMembers()	The list of cluster IDs for secondary clusters within the global cluster.
String	globalClusterResourceId()	The Amazon Web Services Region-unique, immutable identifier for the global database cluster.
boolean	hasGlobalClusterMembers()	For responses, this returns true if the service returned a value for the GlobalClusterMembers property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends GlobalCluster.Builder>	serializableBuilderClass()
String	status()	Specifies the current state of this global cluster.
Boolean	storageEncrypted()	The storage encryption setting for the global cluster.
GlobalCluster.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

globalClusterIdentifier

public final String globalClusterIdentifier()

Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

Returns:

Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

globalClusterResourceId

public final String globalClusterResourceId()

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.

Returns:

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.

globalClusterArn

public final String globalClusterArn()

The Amazon Resource Name (ARN) for the global cluster.

Returns:

The Amazon Resource Name (ARN) for the global cluster.

status

public final String status()

Specifies the current state of this global cluster.

Returns:

Specifies the current state of this global cluster.

engine

public final String engine()

The Amazon DocumentDB database engine used by the global cluster.

Returns:

The Amazon DocumentDB database engine used by the global cluster.

engineVersion

public final String engineVersion()

Indicates the database engine version.

Returns:

Indicates the database engine version.

databaseName

public final String databaseName()

The default database name within the new global cluster.

Returns:

The default database name within the new global cluster.

storageEncrypted

public final Boolean storageEncrypted()

The storage encryption setting for the global cluster.

Returns:

The storage encryption setting for the global cluster.

deletionProtection

public final Boolean deletionProtection()

The deletion protection setting for the new global cluster.

Returns:

The deletion protection setting for the new global cluster.

hasGlobalClusterMembers

public final boolean hasGlobalClusterMembers()

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

globalClusterMembers

public final List<GlobalClusterMember> globalClusterMembers()

The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

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

Returns:

The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

toBuilder

public GlobalCluster.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GlobalCluster.Builder,GlobalCluster>

builder

public static GlobalCluster.Builder builder()

serializableBuilderClass

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