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

Interface ReplicationGroup.Builder

All Superinterfaces:

CopyableBuilder<ReplicationGroup.Builder,ReplicationGroup>, SdkBuilder<ReplicationGroup.Builder,ReplicationGroup>

Enclosing class:

ReplicationGroup

public static interface ReplicationGroup.Builder
extends CopyableBuilder<ReplicationGroup.Builder,ReplicationGroup>

Method Summary

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

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

replicationGroupId

ReplicationGroup.Builder replicationGroupId(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.

description

ReplicationGroup.Builder description(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.

status

ReplicationGroup.Builder status(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.

pendingModifiedValues

ReplicationGroup.Builder pendingModifiedValues(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.

memberClusters

ReplicationGroup.Builder memberClusters(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.

memberClusters

ReplicationGroup.Builder memberClusters(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.

nodeGroups

ReplicationGroup.Builder nodeGroups(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.

nodeGroups

ReplicationGroup.Builder nodeGroups(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.

snapshottingClusterId

ReplicationGroup.Builder snapshottingClusterId(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.

automaticFailover

ReplicationGroup.Builder automaticFailover(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

automaticFailover

ReplicationGroup.Builder automaticFailover(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

configurationEndpoint

ReplicationGroup.Builder configurationEndpoint(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.

snapshotRetentionLimit

ReplicationGroup.Builder snapshotRetentionLimit(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.

snapshotWindow

ReplicationGroup.Builder snapshotWindow(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.

clusterEnabled

ReplicationGroup.Builder clusterEnabled(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.

cacheNodeType

ReplicationGroup.Builder cacheNodeType(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.