Package software.amazon.awssdk.services.elasticache.model

Class ReplicationGroup

java.lang.Object

software.amazon.awssdk.services.elasticache.model.ReplicationGroup

All Implemented Interfaces:

ToCopyableBuilder<ReplicationGroup.Builder,ReplicationGroup>

@Generated("software.amazon.awssdk:codegen")
public class ReplicationGroup
extends Object
implements ToCopyableBuilder<ReplicationGroup.Builder,ReplicationGroup>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ReplicationGroup.Builder

Method Summary

Modifier and Type	Method	Description
String	automaticFailover()	Indicates the status of Multi-AZ for this replication group.
static ReplicationGroup.Builder	builder()
String	cacheNodeType()	The name of the compute and memory capacity node type for each node in the replication group.
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).
Endpoint	configurationEndpoint()	The configuration endpoint for this replicaiton group.
String	description()	The description of the replication group.
boolean	equals(Object obj)
int	hashCode()
List<String>	memberClusters()	The names of all the cache clusters that are part of this replication group.
List<NodeGroup>	nodeGroups()	A single element list with information about the nodes in the replication group.
ReplicationGroupPendingModifiedValues	pendingModifiedValues()	A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
String	replicationGroupId()	The identifier for the replication group.
static Class<? extends ReplicationGroup.Builder>	serializableBuilderClass()
Integer	snapshotRetentionLimit()	The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
String	snapshottingClusterId()	The cache cluster ID that is used as the daily snapshot source for the replication group.
String	snapshotWindow()	The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
String	status()	The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
ReplicationGroup.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

replicationGroupId

public String replicationGroupId()

The identifier for the replication group.

Returns:

The identifier for the replication group.

description

public String description()

The description of the replication group.

Returns:

The description of the replication group.

status

public String status()

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.

pendingModifiedValues

public ReplicationGroupPendingModifiedValues pendingModifiedValues()

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.

memberClusters

public List<String> memberClusters()

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.

nodeGroups

public List<NodeGroup> nodeGroups()

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.

snapshottingClusterId

public String snapshottingClusterId()

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.

automaticFailover

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

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

configurationEndpoint

public Endpoint configurationEndpoint()

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.

snapshotRetentionLimit

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

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.

snapshotWindow

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

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.

clusterEnabled

public 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

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

cacheNodeType

public String cacheNodeType()

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.

toBuilder

public ReplicationGroup.Builder 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 interface ToCopyableBuilder<ReplicationGroup.Builder,ReplicationGroup>

Returns:

a builder for type T

builder

public static ReplicationGroup.Builder builder()

serializableBuilderClass

public static Class<? extends ReplicationGroup.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object