com.amazonaws.services.docdb.model

Class GlobalCluster

java.lang.Object

com.amazonaws.services.docdb.model.GlobalCluster

All Implemented Interfaces:

Serializable, Cloneable

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

A data type representing an Amazon DocumentDB global cluster.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GlobalCluster()

Method Summary

Modifier and Type	Method and Description
GlobalCluster	clone()
boolean	equals(Object obj)
String	getDatabaseName() The default database name within the new global cluster.
Boolean	getDeletionProtection() The deletion protection setting for the new global cluster.
String	getEngine() The Amazon DocumentDB database engine used by the global cluster.
String	getEngineVersion() Indicates the database engine version.
String	getGlobalClusterArn() The Amazon Resource Name (ARN) for the global cluster.
String	getGlobalClusterIdentifier() Contains a user-supplied global cluster identifier.
List<GlobalClusterMember>	getGlobalClusterMembers() The list of cluster IDs for secondary clusters within the global cluster.
String	getGlobalClusterResourceId() The Amazon Web Services Region-unique, immutable identifier for the global database cluster.
String	getStatus() Specifies the current state of this global cluster.
Boolean	getStorageEncrypted() The storage encryption setting for the global cluster.
int	hashCode()
Boolean	isDeletionProtection() The deletion protection setting for the new global cluster.
Boolean	isStorageEncrypted() The storage encryption setting for the global cluster.
void	setDatabaseName(String databaseName) The default database name within the new global cluster.
void	setDeletionProtection(Boolean deletionProtection) The deletion protection setting for the new global cluster.
void	setEngine(String engine) The Amazon DocumentDB database engine used by the global cluster.
void	setEngineVersion(String engineVersion) Indicates the database engine version.
void	setGlobalClusterArn(String globalClusterArn) The Amazon Resource Name (ARN) for the global cluster.
void	setGlobalClusterIdentifier(String globalClusterIdentifier) Contains a user-supplied global cluster identifier.
void	setGlobalClusterMembers(Collection<GlobalClusterMember> globalClusterMembers) The list of cluster IDs for secondary clusters within the global cluster.
void	setGlobalClusterResourceId(String globalClusterResourceId) The Amazon Web Services Region-unique, immutable identifier for the global database cluster.
void	setStatus(String status) Specifies the current state of this global cluster.
void	setStorageEncrypted(Boolean storageEncrypted) The storage encryption setting for the global cluster.
String	toString() Returns a string representation of this object.
GlobalCluster	withDatabaseName(String databaseName) The default database name within the new global cluster.
GlobalCluster	withDeletionProtection(Boolean deletionProtection) The deletion protection setting for the new global cluster.
GlobalCluster	withEngine(String engine) The Amazon DocumentDB database engine used by the global cluster.
GlobalCluster	withEngineVersion(String engineVersion) Indicates the database engine version.
GlobalCluster	withGlobalClusterArn(String globalClusterArn) The Amazon Resource Name (ARN) for the global cluster.
GlobalCluster	withGlobalClusterIdentifier(String globalClusterIdentifier) Contains a user-supplied global cluster identifier.
GlobalCluster	withGlobalClusterMembers(Collection<GlobalClusterMember> globalClusterMembers) The list of cluster IDs for secondary clusters within the global cluster.
GlobalCluster	withGlobalClusterMembers(GlobalClusterMember... globalClusterMembers) The list of cluster IDs for secondary clusters within the global cluster.
GlobalCluster	withGlobalClusterResourceId(String globalClusterResourceId) The Amazon Web Services Region-unique, immutable identifier for the global database cluster.
GlobalCluster	withStatus(String status) Specifies the current state of this global cluster.
GlobalCluster	withStorageEncrypted(Boolean storageEncrypted) The storage encryption setting for the global cluster.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GlobalCluster

public GlobalCluster()

Method Detail

setGlobalClusterIdentifier

public void setGlobalClusterIdentifier(String globalClusterIdentifier)

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

Parameters:

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

getGlobalClusterIdentifier

public String getGlobalClusterIdentifier()

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.

withGlobalClusterIdentifier

public GlobalCluster withGlobalClusterIdentifier(String globalClusterIdentifier)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setGlobalClusterResourceId

public void setGlobalClusterResourceId(String globalClusterResourceId)

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

Parameters:

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

getGlobalClusterResourceId

public String getGlobalClusterResourceId()

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

withGlobalClusterResourceId

public GlobalCluster withGlobalClusterResourceId(String globalClusterResourceId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setGlobalClusterArn

public void setGlobalClusterArn(String globalClusterArn)

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

Parameters:

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

getGlobalClusterArn

public String getGlobalClusterArn()

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

Returns:

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

withGlobalClusterArn

public GlobalCluster withGlobalClusterArn(String globalClusterArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setStatus

public void setStatus(String status)

Specifies the current state of this global cluster.

Parameters:

status - Specifies the current state of this global cluster.

getStatus

public String getStatus()

Specifies the current state of this global cluster.

Returns:

Specifies the current state of this global cluster.

withStatus

public GlobalCluster withStatus(String status)

Specifies the current state of this global cluster.

Parameters:

status - Specifies the current state of this global cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEngine

public void setEngine(String engine)

The Amazon DocumentDB database engine used by the global cluster.

Parameters:

engine - The Amazon DocumentDB database engine used by the global cluster.

getEngine

public String getEngine()

The Amazon DocumentDB database engine used by the global cluster.

Returns:

The Amazon DocumentDB database engine used by the global cluster.

withEngine

public GlobalCluster withEngine(String engine)

The Amazon DocumentDB database engine used by the global cluster.

Parameters:

engine - The Amazon DocumentDB database engine used by the global cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEngineVersion

public void setEngineVersion(String engineVersion)

Indicates the database engine version.

Parameters:

engineVersion - Indicates the database engine version.

getEngineVersion

public String getEngineVersion()

Indicates the database engine version.

Returns:

Indicates the database engine version.

withEngineVersion

public GlobalCluster withEngineVersion(String engineVersion)

Indicates the database engine version.

Parameters:

engineVersion - Indicates the database engine version.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDatabaseName

public void setDatabaseName(String databaseName)

The default database name within the new global cluster.

Parameters:

databaseName - The default database name within the new global cluster.

getDatabaseName

public String getDatabaseName()

The default database name within the new global cluster.

Returns:

The default database name within the new global cluster.

withDatabaseName

public GlobalCluster withDatabaseName(String databaseName)

The default database name within the new global cluster.

Parameters:

databaseName - The default database name within the new global cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStorageEncrypted

public void setStorageEncrypted(Boolean storageEncrypted)

The storage encryption setting for the global cluster.

Parameters:

storageEncrypted - The storage encryption setting for the global cluster.

getStorageEncrypted

public Boolean getStorageEncrypted()

The storage encryption setting for the global cluster.

Returns:

The storage encryption setting for the global cluster.

withStorageEncrypted

public GlobalCluster withStorageEncrypted(Boolean storageEncrypted)

The storage encryption setting for the global cluster.

Parameters:

storageEncrypted - The storage encryption setting for the global cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

isStorageEncrypted

public Boolean isStorageEncrypted()

The storage encryption setting for the global cluster.

Returns:

The storage encryption setting for the global cluster.

setDeletionProtection

public void setDeletionProtection(Boolean deletionProtection)

The deletion protection setting for the new global cluster.

Parameters:

deletionProtection - The deletion protection setting for the new global cluster.

getDeletionProtection

public Boolean getDeletionProtection()

The deletion protection setting for the new global cluster.

Returns:

The deletion protection setting for the new global cluster.

withDeletionProtection

public GlobalCluster withDeletionProtection(Boolean deletionProtection)

The deletion protection setting for the new global cluster.

Parameters:

deletionProtection - The deletion protection setting for the new global cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

isDeletionProtection

public Boolean isDeletionProtection()

The deletion protection setting for the new global cluster.

Returns:

The deletion protection setting for the new global cluster.

getGlobalClusterMembers

public List<GlobalClusterMember> getGlobalClusterMembers()

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

Returns:

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

setGlobalClusterMembers

public void setGlobalClusterMembers(Collection<GlobalClusterMember> globalClusterMembers)

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

Parameters:

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

withGlobalClusterMembers

public GlobalCluster withGlobalClusterMembers(GlobalClusterMember... globalClusterMembers)

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

NOTE: This method appends the values to the existing list (if any). Use setGlobalClusterMembers(java.util.Collection) or withGlobalClusterMembers(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withGlobalClusterMembers

public GlobalCluster withGlobalClusterMembers(Collection<GlobalClusterMember> globalClusterMembers)

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

Parameters:

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

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 GlobalCluster clone()

Overrides:

clone in class Object