GlobalReplicationGroup (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elasticache.model.GlobalReplicationGroup

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GlobalReplicationGroup
extends Object
implements Serializable, Cloneable
```
Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different AWS region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.
- The GlobalReplicationGroupId represents the name of the Global Datastore, which is what you use to associate a secondary cluster.
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GlobalReplicationGroup()

Constructors
Constructor and Description
`GlobalReplicationGroup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GlobalReplicationGroup`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getAtRestEncryptionEnabled()` A flag that enables encryption at rest when set to `true`.
`Boolean`	`getAuthTokenEnabled()` A flag that enables using an `AuthToken` (password) when issuing Redis commands.
`String`	`getCacheNodeType()` The cache node type of the Global Datastore
`Boolean`	`getClusterEnabled()` A flag that indicates whether the Global Datastore is cluster enabled.
`String`	`getEngine()` The Elasticache engine.
`String`	`getEngineVersion()` The Elasticache Redis engine version.
`List<GlobalNodeGroup>`	`getGlobalNodeGroups()` Indicates the slot configuration and global identifier for each slice group.
`String`	`getGlobalReplicationGroupDescription()` The optional description of the Global Datastore
`String`	`getGlobalReplicationGroupId()` The name of the Global Datastore
`List<GlobalReplicationGroupMember>`	`getMembers()` The replication groups that comprise the Global Datastore.
`String`	`getStatus()` The status of the Global Datastore
`Boolean`	`getTransitEncryptionEnabled()` A flag that enables in-transit encryption when set to true.
`int`	`hashCode()`
`Boolean`	`isAtRestEncryptionEnabled()` A flag that enables encryption at rest when set to `true`.
`Boolean`	`isAuthTokenEnabled()` A flag that enables using an `AuthToken` (password) when issuing Redis commands.
`Boolean`	`isClusterEnabled()` A flag that indicates whether the Global Datastore is cluster enabled.
`Boolean`	`isTransitEncryptionEnabled()` A flag that enables in-transit encryption when set to true.
`void`	`setAtRestEncryptionEnabled(Boolean atRestEncryptionEnabled)` A flag that enables encryption at rest when set to `true`.
`void`	`setAuthTokenEnabled(Boolean authTokenEnabled)` A flag that enables using an `AuthToken` (password) when issuing Redis commands.
`void`	`setCacheNodeType(String cacheNodeType)` The cache node type of the Global Datastore
`void`	`setClusterEnabled(Boolean clusterEnabled)` A flag that indicates whether the Global Datastore is cluster enabled.
`void`	`setEngine(String engine)` The Elasticache engine.
`void`	`setEngineVersion(String engineVersion)` The Elasticache Redis engine version.
`void`	`setGlobalNodeGroups(Collection<GlobalNodeGroup> globalNodeGroups)` Indicates the slot configuration and global identifier for each slice group.
`void`	`setGlobalReplicationGroupDescription(String globalReplicationGroupDescription)` The optional description of the Global Datastore
`void`	`setGlobalReplicationGroupId(String globalReplicationGroupId)` The name of the Global Datastore
`void`	`setMembers(Collection<GlobalReplicationGroupMember> members)` The replication groups that comprise the Global Datastore.
`void`	`setStatus(String status)` The status of the Global Datastore
`void`	`setTransitEncryptionEnabled(Boolean transitEncryptionEnabled)` A flag that enables in-transit encryption when set to true.
`String`	`toString()` Returns a string representation of this object.
`GlobalReplicationGroup`	`withAtRestEncryptionEnabled(Boolean atRestEncryptionEnabled)` A flag that enables encryption at rest when set to `true`.
`GlobalReplicationGroup`	`withAuthTokenEnabled(Boolean authTokenEnabled)` A flag that enables using an `AuthToken` (password) when issuing Redis commands.
`GlobalReplicationGroup`	`withCacheNodeType(String cacheNodeType)` The cache node type of the Global Datastore
`GlobalReplicationGroup`	`withClusterEnabled(Boolean clusterEnabled)` A flag that indicates whether the Global Datastore is cluster enabled.
`GlobalReplicationGroup`	`withEngine(String engine)` The Elasticache engine.
`GlobalReplicationGroup`	`withEngineVersion(String engineVersion)` The Elasticache Redis engine version.
`GlobalReplicationGroup`	`withGlobalNodeGroups(Collection<GlobalNodeGroup> globalNodeGroups)` Indicates the slot configuration and global identifier for each slice group.
`GlobalReplicationGroup`	`withGlobalNodeGroups(GlobalNodeGroup... globalNodeGroups)` Indicates the slot configuration and global identifier for each slice group.
`GlobalReplicationGroup`	`withGlobalReplicationGroupDescription(String globalReplicationGroupDescription)` The optional description of the Global Datastore
`GlobalReplicationGroup`	`withGlobalReplicationGroupId(String globalReplicationGroupId)` The name of the Global Datastore
`GlobalReplicationGroup`	`withMembers(Collection<GlobalReplicationGroupMember> members)` The replication groups that comprise the Global Datastore.
`GlobalReplicationGroup`	`withMembers(GlobalReplicationGroupMember... members)` The replication groups that comprise the Global Datastore.
`GlobalReplicationGroup`	`withStatus(String status)` The status of the Global Datastore
`GlobalReplicationGroup`	`withTransitEncryptionEnabled(Boolean transitEncryptionEnabled)` A flag that enables in-transit encryption when set to true.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GlobalReplicationGroup
```
public GlobalReplicationGroup()
```
- Method Detail
  - setGlobalReplicationGroupId
```
public void setGlobalReplicationGroupId(String globalReplicationGroupId)
```
    The name of the Global Datastore
    
    Parameters:
    
    globalReplicationGroupId - The name of the Global Datastore
  - getGlobalReplicationGroupId
```
public String getGlobalReplicationGroupId()
```
    The name of the Global Datastore
    
    Returns:
    
    The name of the Global Datastore
  - withGlobalReplicationGroupId
```
public GlobalReplicationGroup withGlobalReplicationGroupId(String globalReplicationGroupId)
```
    The name of the Global Datastore
    
    Parameters:
    
    globalReplicationGroupId - The name of the Global Datastore
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGlobalReplicationGroupDescription
```
public void setGlobalReplicationGroupDescription(String globalReplicationGroupDescription)
```
    The optional description of the Global Datastore
    
    Parameters:
    
    globalReplicationGroupDescription - The optional description of the Global Datastore
  - getGlobalReplicationGroupDescription
```
public String getGlobalReplicationGroupDescription()
```
    The optional description of the Global Datastore
    
    Returns:
    
    The optional description of the Global Datastore
  - withGlobalReplicationGroupDescription
```
public GlobalReplicationGroup withGlobalReplicationGroupDescription(String globalReplicationGroupDescription)
```
    The optional description of the Global Datastore
    
    Parameters:
    
    globalReplicationGroupDescription - The optional description of the Global Datastore
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the Global Datastore
    
    Parameters:
    
    status - The status of the Global Datastore
  - getStatus
```
public String getStatus()
```
    The status of the Global Datastore
    
    Returns:
    
    The status of the Global Datastore
  - withStatus
```
public GlobalReplicationGroup withStatus(String status)
```
    The status of the Global Datastore
    
    Parameters:
    
    status - The status of the Global Datastore
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCacheNodeType
```
public void setCacheNodeType(String cacheNodeType)
```
    The cache node type of the Global Datastore
    
    Parameters:
    
    cacheNodeType - The cache node type of the Global Datastore
  - getCacheNodeType
```
public String getCacheNodeType()
```
    The cache node type of the Global Datastore
    
    Returns:
    
    The cache node type of the Global Datastore
  - withCacheNodeType
```
public GlobalReplicationGroup withCacheNodeType(String cacheNodeType)
```
    The cache node type of the Global Datastore
    
    Parameters:
    
    cacheNodeType - The cache node type of the Global Datastore
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEngine
```
public void setEngine(String engine)
```
    The Elasticache engine. For preview, it is Redis only.
    
    Parameters:
    
    engine - The Elasticache engine. For preview, it is Redis only.
  - getEngine
```
public String getEngine()
```
    The Elasticache engine. For preview, it is Redis only.
    
    Returns:
    
    The Elasticache engine. For preview, it is Redis only.
  - withEngine
```
public GlobalReplicationGroup withEngine(String engine)
```
    The Elasticache engine. For preview, it is Redis only.
    
    Parameters:
    
    engine - The Elasticache engine. For preview, it is Redis only.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEngineVersion
```
public void setEngineVersion(String engineVersion)
```
    The Elasticache Redis engine version. For preview, it is Redis version 5.0.5 only.
    
    Parameters:
    
    engineVersion - The Elasticache Redis engine version. For preview, it is Redis version 5.0.5 only.
  - getEngineVersion
```
public String getEngineVersion()
```
    The Elasticache Redis engine version. For preview, it is Redis version 5.0.5 only.
    
    Returns:
    
    The Elasticache Redis engine version. For preview, it is Redis version 5.0.5 only.
  - withEngineVersion
```
public GlobalReplicationGroup withEngineVersion(String engineVersion)
```
    The Elasticache Redis engine version. For preview, it is Redis version 5.0.5 only.
    
    Parameters:
    
    engineVersion - The Elasticache Redis engine version. For preview, it is Redis version 5.0.5 only.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getMembers
```
public List<GlobalReplicationGroupMember> getMembers()
```
    The replication groups that comprise the Global Datastore.
    
    Returns:
    
    The replication groups that comprise the Global Datastore.
  - setMembers
```
public void setMembers(Collection<GlobalReplicationGroupMember> members)
```
    The replication groups that comprise the Global Datastore.
    
    Parameters:
    
    members - The replication groups that comprise the Global Datastore.
  - withMembers
```
public GlobalReplicationGroup withMembers(GlobalReplicationGroupMember... members)
```
    The replication groups that comprise the Global Datastore.
    
    NOTE: This method appends the values to the existing list (if any). Use setMembers(java.util.Collection) or withMembers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    members - The replication groups that comprise the Global Datastore.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withMembers
```
public GlobalReplicationGroup withMembers(Collection<GlobalReplicationGroupMember> members)
```
    The replication groups that comprise the Global Datastore.
    
    Parameters:
    
    members - The replication groups that comprise the Global Datastore.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClusterEnabled
```
public void setClusterEnabled(Boolean clusterEnabled)
```
    A flag that indicates whether the Global Datastore is cluster enabled.
    
    Parameters:
    
    clusterEnabled - A flag that indicates whether the Global Datastore is cluster enabled.
  - getClusterEnabled
```
public Boolean getClusterEnabled()
```
    A flag that indicates whether the Global Datastore is cluster enabled.
    
    Returns:
    
    A flag that indicates whether the Global Datastore is cluster enabled.
  - withClusterEnabled
```
public GlobalReplicationGroup withClusterEnabled(Boolean clusterEnabled)
```
    A flag that indicates whether the Global Datastore is cluster enabled.
    
    Parameters:
    
    clusterEnabled - A flag that indicates whether the Global Datastore is cluster enabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isClusterEnabled
```
public Boolean isClusterEnabled()
```
    A flag that indicates whether the Global Datastore is cluster enabled.
    
    Returns:
    
    A flag that indicates whether the Global Datastore is cluster enabled.
  - getGlobalNodeGroups
```
public List<GlobalNodeGroup> getGlobalNodeGroups()
```
    Indicates the slot configuration and global identifier for each slice group.
    
    Returns:
    
    Indicates the slot configuration and global identifier for each slice group.
  - setGlobalNodeGroups
```
public void setGlobalNodeGroups(Collection<GlobalNodeGroup> globalNodeGroups)
```
    Indicates the slot configuration and global identifier for each slice group.
    
    Parameters:
    
    globalNodeGroups - Indicates the slot configuration and global identifier for each slice group.
  - withGlobalNodeGroups
```
public GlobalReplicationGroup withGlobalNodeGroups(GlobalNodeGroup... globalNodeGroups)
```
    Indicates the slot configuration and global identifier for each slice group.
    
    NOTE: This method appends the values to the existing list (if any). Use setGlobalNodeGroups(java.util.Collection) or withGlobalNodeGroups(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    globalNodeGroups - Indicates the slot configuration and global identifier for each slice group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withGlobalNodeGroups
```
public GlobalReplicationGroup withGlobalNodeGroups(Collection<GlobalNodeGroup> globalNodeGroups)
```
    Indicates the slot configuration and global identifier for each slice group.
    
    Parameters:
    
    globalNodeGroups - Indicates the slot configuration and global identifier for each slice group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthTokenEnabled
```
public void setAuthTokenEnabled(Boolean authTokenEnabled)
```
    A flag that enables using an AuthToken (password) when issuing Redis commands.
    
    Default: false
    
    Parameters:
    
    authTokenEnabled - A flag that enables using an AuthToken (password) when issuing Redis commands.
    
    Default: false
  - getAuthTokenEnabled
```
public Boolean getAuthTokenEnabled()
```
    A flag that enables using an AuthToken (password) when issuing Redis commands.
    
    Default: false
    
    Returns:
    
    A flag that enables using an AuthToken (password) when issuing Redis commands.
    
    Default: false
  - withAuthTokenEnabled
```
public GlobalReplicationGroup withAuthTokenEnabled(Boolean authTokenEnabled)
```
    A flag that enables using an AuthToken (password) when issuing Redis commands.
    
    Default: false
    
    Parameters:
    
    authTokenEnabled - A flag that enables using an AuthToken (password) when issuing Redis commands.
    
    Default: false
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAuthTokenEnabled
```
public Boolean isAuthTokenEnabled()
```
    A flag that enables using an AuthToken (password) when issuing Redis commands.
    
    Default: false
    
    Returns:
    
    A flag that enables using an AuthToken (password) when issuing Redis commands.
    
    Default: false
  - setTransitEncryptionEnabled
```
public void setTransitEncryptionEnabled(Boolean transitEncryptionEnabled)
```
    A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
    
    Parameters:
    
    transitEncryptionEnabled - A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
  - getTransitEncryptionEnabled
```
public Boolean getTransitEncryptionEnabled()
```
    A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
    
    Returns:
    
    A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
  - withTransitEncryptionEnabled
```
public GlobalReplicationGroup withTransitEncryptionEnabled(Boolean transitEncryptionEnabled)
```
    A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
    
    Parameters:
    
    transitEncryptionEnabled - A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isTransitEncryptionEnabled
```
public Boolean isTransitEncryptionEnabled()
```
    A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
    
    Returns:
    
    A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
  - setAtRestEncryptionEnabled
```
public void setAtRestEncryptionEnabled(Boolean atRestEncryptionEnabled)
```
    A flag that enables encryption at rest when set to true.
    
    You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.
    
    Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
    
    Parameters:
    
    atRestEncryptionEnabled - A flag that enables encryption at rest when set to true.
    
    You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.
    
    Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
  - getAtRestEncryptionEnabled
```
public Boolean getAtRestEncryptionEnabled()
```
    A flag that enables encryption at rest when set to true.
    
    You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.
    
    Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
    
    Returns:
    
    A flag that enables encryption at rest when set to true.
    
    You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.
    
    Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
  - withAtRestEncryptionEnabled
```
public GlobalReplicationGroup withAtRestEncryptionEnabled(Boolean atRestEncryptionEnabled)
```
    A flag that enables encryption at rest when set to true.
    
    You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.
    
    Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
    
    Parameters:
    
    atRestEncryptionEnabled - A flag that enables encryption at rest when set to true.
    
    You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.
    
    Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAtRestEncryptionEnabled
```
public Boolean isAtRestEncryptionEnabled()
```
    A flag that enables encryption at rest when set to true.
    
    You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.
    
    Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
    
    Returns:
    
    A flag that enables encryption at rest when set to true.
    
    You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.
    
    Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
  - 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 GlobalReplicationGroup clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class GlobalReplicationGroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GlobalReplicationGroup

Method Detail

setGlobalReplicationGroupId

getGlobalReplicationGroupId

withGlobalReplicationGroupId

setGlobalReplicationGroupDescription

getGlobalReplicationGroupDescription

withGlobalReplicationGroupDescription

setStatus

getStatus

withStatus

setCacheNodeType

getCacheNodeType

withCacheNodeType

setEngine

getEngine

withEngine

setEngineVersion

getEngineVersion

withEngineVersion

getMembers

setMembers

withMembers

withMembers

setClusterEnabled

getClusterEnabled

withClusterEnabled

isClusterEnabled

getGlobalNodeGroups

setGlobalNodeGroups

withGlobalNodeGroups

withGlobalNodeGroups

setAuthTokenEnabled

getAuthTokenEnabled

withAuthTokenEnabled

isAuthTokenEnabled

setTransitEncryptionEnabled

getTransitEncryptionEnabled

withTransitEncryptionEnabled

isTransitEncryptionEnabled

setAtRestEncryptionEnabled

getAtRestEncryptionEnabled

withAtRestEncryptionEnabled

isAtRestEncryptionEnabled

toString

equals

hashCode

clone