Class GlobalCluster
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<GlobalCluster.Builder,
GlobalCluster>
A data type representing an Aurora global database.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic GlobalCluster.Builder
builder()
final String
The default database name within the new global database cluster.final Boolean
The deletion protection setting for the new global database cluster.final String
engine()
The Aurora database engine used by the global database cluster.final String
Indicates the database engine version.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FailoverState
A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database).final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final String
The Amazon Resource Name (ARN) for the global database cluster.final String
Contains a user-supplied global database cluster identifier.final List
<GlobalClusterMember> The list of primary and secondary clusters within the global database cluster.final String
The Amazon Web Services Region-unique, immutable identifier for the global database cluster.final boolean
For responses, this returns true if the service returned a value for the GlobalClusterMembers property.final int
hashCode()
static Class
<? extends GlobalCluster.Builder> final String
status()
Specifies the current state of this global database cluster.final Boolean
The storage encryption setting for the global database cluster.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
globalClusterIdentifier
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
- Returns:
- Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
-
globalClusterResourceId
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.
- Returns:
- The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.
-
globalClusterArn
The Amazon Resource Name (ARN) for the global database cluster.
- Returns:
- The Amazon Resource Name (ARN) for the global database cluster.
-
status
Specifies the current state of this global database cluster.
- Returns:
- Specifies the current state of this global database cluster.
-
engine
The Aurora database engine used by the global database cluster.
- Returns:
- The Aurora database engine used by the global database cluster.
-
engineVersion
Indicates the database engine version.
- Returns:
- Indicates the database engine version.
-
databaseName
The default database name within the new global database cluster.
- Returns:
- The default database name within the new global database cluster.
-
storageEncrypted
The storage encryption setting for the global database cluster.
- Returns:
- The storage encryption setting for the global database cluster.
-
deletionProtection
The deletion protection setting for the new global database cluster.
- Returns:
- The deletion protection setting for the new global database 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 theisEmpty()
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
The list of primary and secondary clusters within the global database cluster.
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 primary and secondary clusters within the global database cluster.
-
failoverState
A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database). This object is empty unless the
SwitchoverGlobalCluster
orFailoverGlobalCluster
operation was called on this global cluster.- Returns:
- A data object containing all properties for the current state of an in-process or pending switchover or
failover process for this global cluster (Aurora global database). This object is empty unless the
SwitchoverGlobalCluster
orFailoverGlobalCluster
operation was called on this global cluster.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GlobalCluster.Builder,
GlobalCluster> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-