software.amazon.awssdk.services.elasticache.model

Interface ReplicationGroup.Builder

All Superinterfaces:

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

Enclosing class:

ReplicationGroup

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

Method Summary

Modifier and Type	Method and Description
ReplicationGroup.Builder	atRestEncryptionEnabled(Boolean atRestEncryptionEnabled) A flag that enables encryption at-rest when set to true.
ReplicationGroup.Builder	authTokenEnabled(Boolean authTokenEnabled) A flag that enables using an AuthToken (password) when issuing Redis commands.
ReplicationGroup.Builder	automaticFailover(AutomaticFailoverStatus automaticFailover) Indicates the status of Multi-AZ with automatic failover for this Redis replication group.
ReplicationGroup.Builder	automaticFailover(String automaticFailover) Indicates the status of Multi-AZ with automatic failover for this Redis 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).
default ReplicationGroup.Builder	configurationEndpoint(Consumer<Endpoint.Builder> configurationEndpoint) The configuration endpoint for this replication group.
ReplicationGroup.Builder	configurationEndpoint(Endpoint configurationEndpoint) The configuration endpoint for this replication group.
ReplicationGroup.Builder	description(String description) The user supplied description of the replication group.
ReplicationGroup.Builder	memberClusters(Collection<String> memberClusters) The names of all the cache clusters that are part of this replication group.
ReplicationGroup.Builder	memberClusters(String... memberClusters) The names of all the cache clusters that are part of this replication group.
ReplicationGroup.Builder	nodeGroups(Collection<NodeGroup> nodeGroups) A list of node groups in this replication group.
ReplicationGroup.Builder	nodeGroups(Consumer<NodeGroup.Builder>... nodeGroups) A list of node groups in this replication group.
ReplicationGroup.Builder	nodeGroups(NodeGroup... nodeGroups) A list of node groups in this replication group.
default ReplicationGroup.Builder	pendingModifiedValues(Consumer<ReplicationGroupPendingModifiedValues.Builder> pendingModifiedValues) A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
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 cluster snapshots before deleting them.
ReplicationGroup.Builder	snapshottingClusterId(String snapshottingClusterId) The 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.
ReplicationGroup.Builder	transitEncryptionEnabled(Boolean transitEncryptionEnabled) A flag that enables in-transit encryption when set to true.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, 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 user supplied description of the replication group.

Parameters:

description - The user supplied 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.

pendingModifiedValues

default ReplicationGroup.Builder pendingModifiedValues(Consumer<ReplicationGroupPendingModifiedValues.Builder> pendingModifiedValues)

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

This is a convenience that creates an instance of the ReplicationGroupPendingModifiedValues.Builder avoiding the need to create one manually via ReplicationGroupPendingModifiedValues.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to pendingModifiedValues(ReplicationGroupPendingModifiedValues) .

Parameters:

pendingModifiedValues - a consumer that will call methods on ReplicationGroupPendingModifiedValues.Builder

Returns:

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

See Also:

pendingModifiedValues(ReplicationGroupPendingModifiedValues)

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.

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 list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

Parameters:

nodeGroups - A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

Returns:

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

nodeGroups

ReplicationGroup.Builder nodeGroups(NodeGroup... nodeGroups)

A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

Parameters:

nodeGroups - A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

Returns:

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

nodeGroups

ReplicationGroup.Builder nodeGroups(Consumer<NodeGroup.Builder>... nodeGroups)

A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #nodeGroups(List).

Parameters:

nodeGroups - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#nodeGroups(List)

snapshottingClusterId

ReplicationGroup.Builder snapshottingClusterId(String snapshottingClusterId)

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

Parameters:

snapshottingClusterId - The 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 with automatic failover for this Redis replication group.

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover 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 with automatic failover for this Redis replication group.

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover 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, AutomaticFailoverStatus

automaticFailover

ReplicationGroup.Builder automaticFailover(AutomaticFailoverStatus automaticFailover)

Indicates the status of Multi-AZ with automatic failover for this Redis replication group.

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover 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 with automatic failover for this Redis replication group.

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover 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, AutomaticFailoverStatus

configurationEndpoint

ReplicationGroup.Builder configurationEndpoint(Endpoint configurationEndpoint)

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

Parameters:

configurationEndpoint - The configuration endpoint for this replication 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.

configurationEndpoint

default ReplicationGroup.Builder configurationEndpoint(Consumer<Endpoint.Builder> configurationEndpoint)

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

This is a convenience that creates an instance of the Endpoint.Builder avoiding the need to create one manually via Endpoint.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to configurationEndpoint(Endpoint).

Parameters:

configurationEndpoint - a consumer that will call methods on Endpoint.Builder

Returns:

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

See Also:

configurationEndpoint(Endpoint)

snapshotRetentionLimit

ReplicationGroup.Builder snapshotRetentionLimit(Integer snapshotRetentionLimit)

The number of days for which ElastiCache retains automatic 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 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.

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.

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.

authTokenEnabled

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

transitEncryptionEnabled

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

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x.

Default: false

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.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x.

Default: false

Returns:

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

atRestEncryptionEnabled

ReplicationGroup.Builder atRestEncryptionEnabled(Boolean atRestEncryptionEnabled)

A flag that enables encryption at-rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x.

Default: false

Parameters:

atRestEncryptionEnabled - A flag that enables encryption at-rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x.

Default: false

Returns:

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