com.amazonaws.services.neptune.model

Class GlobalCluster

java.lang.Object

com.amazonaws.services.neptune.model.GlobalCluster

All Implemented Interfaces:

Serializable, Cloneable

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

Contains the details of an Amazon Neptune global database.

This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.

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)
Boolean	getDeletionProtection() The deletion protection setting for the global database.
String	getEngine() The Neptune database engine used by the global database ("neptune").
String	getEngineVersion() The Neptune engine version used by the global database.
String	getGlobalClusterArn() The Amazon Resource Name (ARN) for the global database.
String	getGlobalClusterIdentifier() Contains a user-supplied global database cluster identifier.
List<GlobalClusterMember>	getGlobalClusterMembers() A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.
String	getGlobalClusterResourceId() An immutable identifier for the global database that is unique within in all regions.
String	getStatus() Specifies the current state of this global database.
Boolean	getStorageEncrypted() The storage encryption setting for the global database.
int	hashCode()
Boolean	isDeletionProtection() The deletion protection setting for the global database.
Boolean	isStorageEncrypted() The storage encryption setting for the global database.
void	setDeletionProtection(Boolean deletionProtection) The deletion protection setting for the global database.
void	setEngine(String engine) The Neptune database engine used by the global database ("neptune").
void	setEngineVersion(String engineVersion) The Neptune engine version used by the global database.
void	setGlobalClusterArn(String globalClusterArn) The Amazon Resource Name (ARN) for the global database.
void	setGlobalClusterIdentifier(String globalClusterIdentifier) Contains a user-supplied global database cluster identifier.
void	setGlobalClusterMembers(Collection<GlobalClusterMember> globalClusterMembers) A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.
void	setGlobalClusterResourceId(String globalClusterResourceId) An immutable identifier for the global database that is unique within in all regions.
void	setStatus(String status) Specifies the current state of this global database.
void	setStorageEncrypted(Boolean storageEncrypted) The storage encryption setting for the global database.
String	toString() Returns a string representation of this object.
GlobalCluster	withDeletionProtection(Boolean deletionProtection) The deletion protection setting for the global database.
GlobalCluster	withEngine(String engine) The Neptune database engine used by the global database ("neptune").
GlobalCluster	withEngineVersion(String engineVersion) The Neptune engine version used by the global database.
GlobalCluster	withGlobalClusterArn(String globalClusterArn) The Amazon Resource Name (ARN) for the global database.
GlobalCluster	withGlobalClusterIdentifier(String globalClusterIdentifier) Contains a user-supplied global database cluster identifier.
GlobalCluster	withGlobalClusterMembers(Collection<GlobalClusterMember> globalClusterMembers) A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.
GlobalCluster	withGlobalClusterMembers(GlobalClusterMember... globalClusterMembers) A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.
GlobalCluster	withGlobalClusterResourceId(String globalClusterResourceId) An immutable identifier for the global database that is unique within in all regions.
GlobalCluster	withStatus(String status) Specifies the current state of this global database.
GlobalCluster	withStorageEncrypted(Boolean storageEncrypted) The storage encryption setting for the global database.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GlobalCluster

public GlobalCluster()

Method Detail

setGlobalClusterIdentifier

public void setGlobalClusterIdentifier(String globalClusterIdentifier)

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

Parameters:

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

getGlobalClusterIdentifier

public String getGlobalClusterIdentifier()

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

Returns:

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

withGlobalClusterIdentifier

public GlobalCluster withGlobalClusterIdentifier(String globalClusterIdentifier)

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

Parameters:

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

Returns:

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

setGlobalClusterResourceId

public void setGlobalClusterResourceId(String globalClusterResourceId)

An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

Parameters:

globalClusterResourceId - An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

getGlobalClusterResourceId

public String getGlobalClusterResourceId()

An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

Returns:

An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

withGlobalClusterResourceId

public GlobalCluster withGlobalClusterResourceId(String globalClusterResourceId)

An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

Parameters:

globalClusterResourceId - An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB 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 database.

Parameters:

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

getGlobalClusterArn

public String getGlobalClusterArn()

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

Returns:

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

withGlobalClusterArn

public GlobalCluster withGlobalClusterArn(String globalClusterArn)

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

Parameters:

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

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 database.

Parameters:

status - Specifies the current state of this global database.

getStatus

public String getStatus()

Specifies the current state of this global database.

Returns:

Specifies the current state of this global database.

withStatus

public GlobalCluster withStatus(String status)

Specifies the current state of this global database.

Parameters:

status - Specifies the current state of this global database.

Returns:

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

setEngine

public void setEngine(String engine)

The Neptune database engine used by the global database ("neptune").

Parameters:

engine - The Neptune database engine used by the global database ("neptune").

getEngine

public String getEngine()

The Neptune database engine used by the global database ("neptune").

Returns:

The Neptune database engine used by the global database ("neptune").

withEngine

public GlobalCluster withEngine(String engine)

The Neptune database engine used by the global database ("neptune").

Parameters:

engine - The Neptune database engine used by the global database ("neptune").

Returns:

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

setEngineVersion

public void setEngineVersion(String engineVersion)

The Neptune engine version used by the global database.

Parameters:

engineVersion - The Neptune engine version used by the global database.

getEngineVersion

public String getEngineVersion()

The Neptune engine version used by the global database.

Returns:

The Neptune engine version used by the global database.

withEngineVersion

public GlobalCluster withEngineVersion(String engineVersion)

The Neptune engine version used by the global database.

Parameters:

engineVersion - The Neptune engine version used by the global database.

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 database.

Parameters:

storageEncrypted - The storage encryption setting for the global database.

getStorageEncrypted

public Boolean getStorageEncrypted()

The storage encryption setting for the global database.

Returns:

The storage encryption setting for the global database.

withStorageEncrypted

public GlobalCluster withStorageEncrypted(Boolean storageEncrypted)

The storage encryption setting for the global database.

Parameters:

storageEncrypted - The storage encryption setting for the global database.

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 database.

Returns:

The storage encryption setting for the global database.

setDeletionProtection

public void setDeletionProtection(Boolean deletionProtection)

The deletion protection setting for the global database.

Parameters:

deletionProtection - The deletion protection setting for the global database.

getDeletionProtection

public Boolean getDeletionProtection()

The deletion protection setting for the global database.

Returns:

The deletion protection setting for the global database.

withDeletionProtection

public GlobalCluster withDeletionProtection(Boolean deletionProtection)

The deletion protection setting for the global database.

Parameters:

deletionProtection - The deletion protection setting for the global database.

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 global database.

Returns:

The deletion protection setting for the global database.

getGlobalClusterMembers

public List<GlobalClusterMember> getGlobalClusterMembers()

A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

Returns:

A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

setGlobalClusterMembers

public void setGlobalClusterMembers(Collection<GlobalClusterMember> globalClusterMembers)

A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

Parameters:

globalClusterMembers - A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

withGlobalClusterMembers

public GlobalCluster withGlobalClusterMembers(GlobalClusterMember... globalClusterMembers)

A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

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 - A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

Returns:

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

withGlobalClusterMembers

public GlobalCluster withGlobalClusterMembers(Collection<GlobalClusterMember> globalClusterMembers)

A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

Parameters:

globalClusterMembers - A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

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