Class GlobalReplicationGroup
- java.lang.Object
-
- software.amazon.awssdk.services.elasticache.model.GlobalReplicationGroup
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<GlobalReplicationGroup.Builder,GlobalReplicationGroup>
@Generated("software.amazon.awssdk:codegen") public final class GlobalReplicationGroup extends Object implements SdkPojo, Serializable, ToCopyableBuilder<GlobalReplicationGroup.Builder,GlobalReplicationGroup>
Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.
-
The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGlobalReplicationGroup.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The ARN (Amazon Resource Name) of the global replication group.BooleanatRestEncryptionEnabled()A flag that enables encryption at rest when set totrue.BooleanauthTokenEnabled()A flag that enables using anAuthToken(password) when issuing Valkey or Redis OSS commands.static GlobalReplicationGroup.Builderbuilder()StringcacheNodeType()The cache node type of the Global datastoreBooleanclusterEnabled()A flag that indicates whether the Global datastore is cluster enabled.Stringengine()The ElastiCache engine.StringengineVersion()The ElastiCache engine version.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)List<GlobalNodeGroup>globalNodeGroups()Indicates the slot configuration and global identifier for each slice group.StringglobalReplicationGroupDescription()The optional description of the Global datastoreStringglobalReplicationGroupId()The name of the Global datastorebooleanhasGlobalNodeGroups()For responses, this returns true if the service returned a value for the GlobalNodeGroups property.inthashCode()booleanhasMembers()For responses, this returns true if the service returned a value for the Members property.List<GlobalReplicationGroupMember>members()The replication groups that comprise the Global datastore.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends GlobalReplicationGroup.Builder>serializableBuilderClass()Stringstatus()The status of the Global datastoreGlobalReplicationGroup.BuildertoBuilder()StringtoString()Returns a string representation of this object.BooleantransitEncryptionEnabled()A flag that enables in-transit encryption when set to true.-
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
-
globalReplicationGroupId
public final String globalReplicationGroupId()
The name of the Global datastore
- Returns:
- The name of the Global datastore
-
globalReplicationGroupDescription
public final String globalReplicationGroupDescription()
The optional description of the Global datastore
- Returns:
- The optional description of the Global datastore
-
status
public final String status()
The status of the Global datastore
- Returns:
- The status of the Global datastore
-
cacheNodeType
public final String cacheNodeType()
The cache node type of the Global datastore
- Returns:
- The cache node type of the Global datastore
-
engine
public final String engine()
The ElastiCache engine. For Valkey or Redis OSS only.
- Returns:
- The ElastiCache engine. For Valkey or Redis OSS only.
-
engineVersion
public final String engineVersion()
The ElastiCache engine version.
- Returns:
- The ElastiCache engine version.
-
hasMembers
public final boolean hasMembers()
For responses, this returns true if the service returned a value for the Members 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.
-
members
public final List<GlobalReplicationGroupMember> members()
The replication groups that comprise the Global datastore.
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
hasMembers()method.- Returns:
- The replication groups that comprise the Global datastore.
-
clusterEnabled
public final Boolean clusterEnabled()
A flag that indicates whether the Global datastore is cluster enabled.
- Returns:
- A flag that indicates whether the Global datastore is cluster enabled.
-
hasGlobalNodeGroups
public final boolean hasGlobalNodeGroups()
For responses, this returns true if the service returned a value for the GlobalNodeGroups 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.
-
globalNodeGroups
public final List<GlobalNodeGroup> globalNodeGroups()
Indicates the slot configuration and global identifier for each slice group.
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
hasGlobalNodeGroups()method.- Returns:
- Indicates the slot configuration and global identifier for each slice group.
-
authTokenEnabled
public final Boolean authTokenEnabled()
A flag that enables using an
AuthToken(password) when issuing Valkey or Redis OSS commands.Default:
false- Returns:
- A flag that enables using an
AuthToken(password) when issuing Valkey or Redis OSS commands.Default:
false
-
transitEncryptionEnabled
public final Boolean transitEncryptionEnabled()
A flag that enables in-transit encryption when set to true.
Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version
3.2.6,4.xor later.- Returns:
- A flag that enables in-transit encryption when set to true.
Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version
3.2.6,4.xor later.
-
atRestEncryptionEnabled
public final Boolean atRestEncryptionEnabled()
A flag that enables encryption at rest when set to
true.You cannot modify the value of
AtRestEncryptionEnabledafter the replication group is created. To enable encryption at rest on a replication group you must setAtRestEncryptionEnabledtotruewhen you create the replication group.Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version
3.2.6,4.xor later.- Returns:
- A flag that enables encryption at rest when set to
true.You cannot modify the value of
AtRestEncryptionEnabledafter the replication group is created. To enable encryption at rest on a replication group you must setAtRestEncryptionEnabledtotruewhen you create the replication group.Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version
3.2.6,4.xor later.
-
arn
public final String arn()
The ARN (Amazon Resource Name) of the global replication group.
- Returns:
- The ARN (Amazon Resource Name) of the global replication group.
-
toBuilder
public GlobalReplicationGroup.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GlobalReplicationGroup.Builder,GlobalReplicationGroup>
-
builder
public static GlobalReplicationGroup.Builder builder()
-
serializableBuilderClass
public static Class<? extends GlobalReplicationGroup.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-