com.amazonaws.services.elasticache.model

Class ReplicationGroup

java.lang.Object

com.amazonaws.services.elasticache.model.ReplicationGroup

All Implemented Interfaces:

Serializable, Cloneable

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

Contains all of the attributes of a specific Redis replication group.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReplicationGroup()

Method Summary

Modifier and Type	Method and Description
ReplicationGroup	clone()
boolean	equals(Object obj)
String	getAutomaticFailover() Indicates the status of Multi-AZ for this replication group.
String	getCacheNodeType() The name of the compute and memory capacity node type for each node in the replication group.
Boolean	getClusterEnabled() A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).
Endpoint	getConfigurationEndpoint() The configuration endpoint for this replicaiton group.
String	getDescription() The description of the replication group.
List<String>	getMemberClusters() The names of all the cache clusters that are part of this replication group.
List<NodeGroup>	getNodeGroups() A single element list with information about the nodes in the replication group.
ReplicationGroupPendingModifiedValues	getPendingModifiedValues() A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
String	getReplicationGroupId() The identifier for the replication group.
Integer	getSnapshotRetentionLimit() The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
String	getSnapshottingClusterId() The cache cluster ID that is used as the daily snapshot source for the replication group.
String	getSnapshotWindow() The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
String	getStatus() The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
int	hashCode()
Boolean	isClusterEnabled() A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).
void	setAutomaticFailover(AutomaticFailoverStatus automaticFailover) Indicates the status of Multi-AZ for this replication group.
void	setAutomaticFailover(String automaticFailover) Indicates the status of Multi-AZ for this replication group.
void	setCacheNodeType(String cacheNodeType) The name of the compute and memory capacity node type for each node in the replication group.
void	setClusterEnabled(Boolean clusterEnabled) A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).
void	setConfigurationEndpoint(Endpoint configurationEndpoint) The configuration endpoint for this replicaiton group.
void	setDescription(String description) The description of the replication group.
void	setMemberClusters(Collection<String> memberClusters) The names of all the cache clusters that are part of this replication group.
void	setNodeGroups(Collection<NodeGroup> nodeGroups) A single element list with information about the nodes in the replication group.
void	setPendingModifiedValues(ReplicationGroupPendingModifiedValues pendingModifiedValues) A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
void	setReplicationGroupId(String replicationGroupId) The identifier for the replication group.
void	setSnapshotRetentionLimit(Integer snapshotRetentionLimit) The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
void	setSnapshottingClusterId(String snapshottingClusterId) The cache cluster ID that is used as the daily snapshot source for the replication group.
void	setSnapshotWindow(String snapshotWindow) The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
void	setStatus(String status) The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ReplicationGroup	withAutomaticFailover(AutomaticFailoverStatus automaticFailover) Indicates the status of Multi-AZ for this replication group.
ReplicationGroup	withAutomaticFailover(String automaticFailover) Indicates the status of Multi-AZ for this replication group.
ReplicationGroup	withCacheNodeType(String cacheNodeType) The name of the compute and memory capacity node type for each node in the replication group.
ReplicationGroup	withClusterEnabled(Boolean clusterEnabled) A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).
ReplicationGroup	withConfigurationEndpoint(Endpoint configurationEndpoint) The configuration endpoint for this replicaiton group.
ReplicationGroup	withDescription(String description) The description of the replication group.
ReplicationGroup	withMemberClusters(Collection<String> memberClusters) The names of all the cache clusters that are part of this replication group.
ReplicationGroup	withMemberClusters(String... memberClusters) The names of all the cache clusters that are part of this replication group.
ReplicationGroup	withNodeGroups(Collection<NodeGroup> nodeGroups) A single element list with information about the nodes in the replication group.
ReplicationGroup	withNodeGroups(NodeGroup... nodeGroups) A single element list with information about the nodes in the replication group.
ReplicationGroup	withPendingModifiedValues(ReplicationGroupPendingModifiedValues pendingModifiedValues) A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
ReplicationGroup	withReplicationGroupId(String replicationGroupId) The identifier for the replication group.
ReplicationGroup	withSnapshotRetentionLimit(Integer snapshotRetentionLimit) The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
ReplicationGroup	withSnapshottingClusterId(String snapshottingClusterId) The cache cluster ID that is used as the daily snapshot source for the replication group.
ReplicationGroup	withSnapshotWindow(String snapshotWindow) The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
ReplicationGroup	withStatus(String status) The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReplicationGroup

public ReplicationGroup()

Method Detail

setReplicationGroupId

public void setReplicationGroupId(String replicationGroupId)

The identifier for the replication group.

Parameters:

replicationGroupId - The identifier for the replication group.

getReplicationGroupId

public String getReplicationGroupId()

The identifier for the replication group.

Returns:

The identifier for the replication group.

withReplicationGroupId

public ReplicationGroup withReplicationGroupId(String replicationGroupId)

The identifier for the replication group.

Parameters:

replicationGroupId - The identifier for the replication group.

Returns:

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

setDescription

public void setDescription(String description)

The description of the replication group.

Parameters:

description - The description of the replication group.

getDescription

public String getDescription()

The description of the replication group.

Returns:

The description of the replication group.

withDescription

public ReplicationGroup withDescription(String description)

The description of the replication group.

Parameters:

description - The description of the replication group.

Returns:

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

setStatus

public void setStatus(String status)

The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

Parameters:

status - The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

getStatus

public String getStatus()

The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

Returns:

The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

withStatus

public ReplicationGroup withStatus(String status)

The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

Parameters:

status - The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

Returns:

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

setPendingModifiedValues

public void setPendingModifiedValues(ReplicationGroupPendingModifiedValues pendingModifiedValues)

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

Parameters:

pendingModifiedValues - A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

getPendingModifiedValues

public ReplicationGroupPendingModifiedValues getPendingModifiedValues()

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

Returns:

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

withPendingModifiedValues

public ReplicationGroup withPendingModifiedValues(ReplicationGroupPendingModifiedValues pendingModifiedValues)

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

Parameters:

pendingModifiedValues - A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

Returns:

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

getMemberClusters

public List<String> getMemberClusters()

The names of all the cache clusters that are part of this replication group.

Returns:

The names of all the cache clusters that are part of this replication group.

setMemberClusters

public void setMemberClusters(Collection<String> memberClusters)

The names of all the cache clusters that are part of this replication group.

Parameters:

memberClusters - The names of all the cache clusters that are part of this replication group.

withMemberClusters

public ReplicationGroup withMemberClusters(String... memberClusters)

The names of all the cache clusters that are part of this replication group.

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

Parameters:

memberClusters - The names of all the cache clusters that are part of this replication group.

Returns:

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

withMemberClusters

public ReplicationGroup withMemberClusters(Collection<String> memberClusters)

The names of all the cache clusters that are part of this replication group.

Parameters:

memberClusters - The names of all the cache clusters that are part of this replication group.

Returns:

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

getNodeGroups

public List<NodeGroup> getNodeGroups()

A single element list with information about the nodes in the replication group.

Returns:

A single element list with information about the nodes in the replication group.

setNodeGroups

public void setNodeGroups(Collection<NodeGroup> nodeGroups)

A single element list with information about the nodes in the replication group.

Parameters:

nodeGroups - A single element list with information about the nodes in the replication group.

withNodeGroups

public ReplicationGroup withNodeGroups(NodeGroup... nodeGroups)

A single element list with information about the nodes in the replication group.

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

Parameters:

nodeGroups - A single element list with information about the nodes in the replication group.

Returns:

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

withNodeGroups

public ReplicationGroup withNodeGroups(Collection<NodeGroup> nodeGroups)

A single element list with information about the nodes in the replication group.

Parameters:

nodeGroups - A single element list with information about the nodes in the replication group.

Returns:

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

setSnapshottingClusterId

public void setSnapshottingClusterId(String snapshottingClusterId)

The cache cluster ID that is used as the daily snapshot source for the replication group.

Parameters:

snapshottingClusterId - The cache cluster ID that is used as the daily snapshot source for the replication group.

getSnapshottingClusterId

public String getSnapshottingClusterId()

The cache cluster ID that is used as the daily snapshot source for the replication group.

Returns:

The cache cluster ID that is used as the daily snapshot source for the replication group.

withSnapshottingClusterId

public ReplicationGroup withSnapshottingClusterId(String snapshottingClusterId)

The cache cluster ID that is used as the daily snapshot source for the replication group.

Parameters:

snapshottingClusterId - The cache cluster ID that is used as the daily snapshot source for the replication group.

Returns:

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

setAutomaticFailover

public void setAutomaticFailover(String automaticFailover)

Indicates the status of Multi-AZ for this replication group.

ElastiCache Multi-AZ replication groups are not supported on:

• Redis versions earlier than 2.8.6.

• Redis (cluster mode disabled):T1 and T2 cache node types.

  Redis (cluster mode enabled): T1 node types.

Parameters:

automaticFailover - Indicates the status of Multi-AZ for this replication group.

ElastiCache Multi-AZ replication groups are not supported on:

• Redis versions earlier than 2.8.6.

• Redis (cluster mode disabled):T1 and T2 cache node types.

  Redis (cluster mode enabled): T1 node types.

See Also:

AutomaticFailoverStatus

getAutomaticFailover

public String getAutomaticFailover()

Indicates the status of Multi-AZ for this replication group.

ElastiCache Multi-AZ replication groups are not supported on:

• Redis versions earlier than 2.8.6.

• Redis (cluster mode disabled):T1 and T2 cache node types.

  Redis (cluster mode enabled): T1 node types.

Returns:

Indicates the status of Multi-AZ for this replication group.

ElastiCache Multi-AZ replication groups are not supported on:

• Redis versions earlier than 2.8.6.

• Redis (cluster mode disabled):T1 and T2 cache node types.

  Redis (cluster mode enabled): T1 node types.

See Also:

AutomaticFailoverStatus

withAutomaticFailover

public ReplicationGroup withAutomaticFailover(String automaticFailover)

Indicates the status of Multi-AZ for this replication group.

ElastiCache Multi-AZ replication groups are not supported on:

• Redis versions earlier than 2.8.6.

• Redis (cluster mode disabled):T1 and T2 cache node types.

  Redis (cluster mode enabled): T1 node types.

Parameters:

automaticFailover - Indicates the status of Multi-AZ for this replication group.

ElastiCache Multi-AZ replication groups are not supported on:

• Redis versions earlier than 2.8.6.

• Redis (cluster mode disabled):T1 and T2 cache node types.

  Redis (cluster mode enabled): T1 node types.

Returns:

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

See Also:

AutomaticFailoverStatus

setAutomaticFailover

public void setAutomaticFailover(AutomaticFailoverStatus automaticFailover)

Indicates the status of Multi-AZ for this replication group.

ElastiCache Multi-AZ replication groups are not supported on:

• Redis versions earlier than 2.8.6.

• Redis (cluster mode disabled):T1 and T2 cache node types.

  Redis (cluster mode enabled): T1 node types.

Parameters:

automaticFailover - Indicates the status of Multi-AZ for this replication group.

ElastiCache Multi-AZ replication groups are not supported on:

• Redis versions earlier than 2.8.6.

• Redis (cluster mode disabled):T1 and T2 cache node types.

  Redis (cluster mode enabled): T1 node types.

See Also:

AutomaticFailoverStatus

withAutomaticFailover

public ReplicationGroup withAutomaticFailover(AutomaticFailoverStatus automaticFailover)

Indicates the status of Multi-AZ for this replication group.

ElastiCache Multi-AZ replication groups are not supported on:

• Redis versions earlier than 2.8.6.

• Redis (cluster mode disabled):T1 and T2 cache node types.

  Redis (cluster mode enabled): T1 node types.

Parameters:

automaticFailover - Indicates the status of Multi-AZ for this replication group.

ElastiCache Multi-AZ replication groups are not supported on:

• Redis versions earlier than 2.8.6.

• Redis (cluster mode disabled):T1 and T2 cache node types.

  Redis (cluster mode enabled): T1 node types.

Returns:

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

See Also:

AutomaticFailoverStatus

setConfigurationEndpoint

public void setConfigurationEndpoint(Endpoint configurationEndpoint)

The configuration endpoint for this replicaiton group. Use the configuration endpoint to connect to this replication group.

Parameters:

configurationEndpoint - The configuration endpoint for this replicaiton group. Use the configuration endpoint to connect to this replication group.

getConfigurationEndpoint

public Endpoint getConfigurationEndpoint()

The configuration endpoint for this replicaiton group. Use the configuration endpoint to connect to this replication group.

Returns:

The configuration endpoint for this replicaiton group. Use the configuration endpoint to connect to this replication group.

withConfigurationEndpoint

public ReplicationGroup withConfigurationEndpoint(Endpoint configurationEndpoint)

The configuration endpoint for this replicaiton group. Use the configuration endpoint to connect to this replication group.

Parameters:

configurationEndpoint - The configuration endpoint for this replicaiton group. Use the configuration endpoint to connect to this replication group.

Returns:

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

setSnapshotRetentionLimit

public void setSnapshotRetentionLimit(Integer snapshotRetentionLimit)

The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

Parameters:

snapshotRetentionLimit - The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

getSnapshotRetentionLimit

public Integer getSnapshotRetentionLimit()

The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

Returns:

The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

withSnapshotRetentionLimit

public ReplicationGroup withSnapshotRetentionLimit(Integer snapshotRetentionLimit)

The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

Parameters:

snapshotRetentionLimit - The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

Returns:

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

setSnapshotWindow

public void setSnapshotWindow(String snapshotWindow)

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Note: This parameter is only valid if the Engine parameter is redis.

Parameters:

snapshotWindow - The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Note: This parameter is only valid if the Engine parameter is redis.

getSnapshotWindow

public String getSnapshotWindow()

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Note: This parameter is only valid if the Engine parameter is redis.

Returns:

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Note: This parameter is only valid if the Engine parameter is redis.

withSnapshotWindow

public ReplicationGroup withSnapshotWindow(String snapshotWindow)

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Note: This parameter is only valid if the Engine parameter is redis.

Parameters:

snapshotWindow - The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Note: This parameter is only valid if the Engine parameter is redis.

Returns:

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

setClusterEnabled

public void setClusterEnabled(Boolean clusterEnabled)

A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

Valid values: true | false

Parameters:

clusterEnabled - A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

Valid values: true | false

getClusterEnabled

public Boolean getClusterEnabled()

A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

Valid values: true | false

Returns:

A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

Valid values: true | false

withClusterEnabled

public ReplicationGroup withClusterEnabled(Boolean clusterEnabled)

A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

Valid values: true | false

Parameters:

clusterEnabled - A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

Valid values: true | false

Returns:

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

isClusterEnabled

public Boolean isClusterEnabled()

A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

Valid values: true | false

Returns:

A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

Valid values: true | false

setCacheNodeType

public void setCacheNodeType(String cacheNodeType)

The name of the compute and memory capacity node type for each node in the replication group.

Parameters:

cacheNodeType - The name of the compute and memory capacity node type for each node in the replication group.

getCacheNodeType

public String getCacheNodeType()

The name of the compute and memory capacity node type for each node in the replication group.

Returns:

The name of the compute and memory capacity node type for each node in the replication group.

withCacheNodeType

public ReplicationGroup withCacheNodeType(String cacheNodeType)

The name of the compute and memory capacity node type for each node in the replication group.

Parameters:

cacheNodeType - The name of the compute and memory capacity node type for each node in the replication group.

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; useful for testing and debugging.

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

Overrides:

clone in class Object