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

Interface GlobalReplicationGroup.Builder

All Superinterfaces:

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

Enclosing class:

GlobalReplicationGroup

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

Method Summary

Modifier and Type	Method	Description
GlobalReplicationGroup.Builder	arn(String arn)	The ARN (Amazon Resource Name) of the global replication group.
GlobalReplicationGroup.Builder	atRestEncryptionEnabled(Boolean atRestEncryptionEnabled)	A flag that enables encryption at rest when set to true.
GlobalReplicationGroup.Builder	authTokenEnabled(Boolean authTokenEnabled)	A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.
GlobalReplicationGroup.Builder	cacheNodeType(String cacheNodeType)	The cache node type of the Global datastore
GlobalReplicationGroup.Builder	clusterEnabled(Boolean clusterEnabled)	A flag that indicates whether the Global datastore is cluster enabled.
GlobalReplicationGroup.Builder	engine(String engine)	The ElastiCache engine.
GlobalReplicationGroup.Builder	engineVersion(String engineVersion)	The ElastiCache engine version.
GlobalReplicationGroup.Builder	globalNodeGroups(Collection<GlobalNodeGroup> globalNodeGroups)	Indicates the slot configuration and global identifier for each slice group.
GlobalReplicationGroup.Builder	globalNodeGroups(Consumer<GlobalNodeGroup.Builder>... globalNodeGroups)	Indicates the slot configuration and global identifier for each slice group.
GlobalReplicationGroup.Builder	globalNodeGroups(GlobalNodeGroup... globalNodeGroups)	Indicates the slot configuration and global identifier for each slice group.
GlobalReplicationGroup.Builder	globalReplicationGroupDescription(String globalReplicationGroupDescription)	The optional description of the Global datastore
GlobalReplicationGroup.Builder	globalReplicationGroupId(String globalReplicationGroupId)	The name of the Global datastore
GlobalReplicationGroup.Builder	members(Collection<GlobalReplicationGroupMember> members)	The replication groups that comprise the Global datastore.
GlobalReplicationGroup.Builder	members(Consumer<GlobalReplicationGroupMember.Builder>... members)	The replication groups that comprise the Global datastore.
GlobalReplicationGroup.Builder	members(GlobalReplicationGroupMember... members)	The replication groups that comprise the Global datastore.
GlobalReplicationGroup.Builder	status(String status)	The status of the Global datastore
GlobalReplicationGroup.Builder	transitEncryptionEnabled(Boolean transitEncryptionEnabled)	A flag that enables in-transit encryption when set to true.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

globalReplicationGroupId

GlobalReplicationGroup.Builder globalReplicationGroupId(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.

globalReplicationGroupDescription

GlobalReplicationGroup.Builder globalReplicationGroupDescription(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.

status

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

cacheNodeType

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

engine

GlobalReplicationGroup.Builder engine(String engine)

The ElastiCache engine. For Valkey or Redis OSS only.

Parameters:

engine - The ElastiCache engine. For Valkey or Redis OSS only.

Returns:

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

engineVersion

GlobalReplicationGroup.Builder engineVersion(String engineVersion)

The ElastiCache engine version.

Parameters:

engineVersion - The ElastiCache engine version.

Returns:

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

members

GlobalReplicationGroup.Builder members(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.

members

GlobalReplicationGroup.Builder members(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.

members

GlobalReplicationGroup.Builder members(Consumer<GlobalReplicationGroupMember.Builder>... members)

The replication groups that comprise the Global datastore.

This is a convenience method that creates an instance of the GlobalReplicationGroupMember.Builder avoiding the need to create one manually via GlobalReplicationGroupMember.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #members(List).

Parameters:

members - a consumer that will call methods on GlobalReplicationGroupMember.Builder

Returns:

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

See Also:

#members(java.util.Collection)

clusterEnabled

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

globalNodeGroups

GlobalReplicationGroup.Builder globalNodeGroups(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.

globalNodeGroups

GlobalReplicationGroup.Builder globalNodeGroups(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.

globalNodeGroups

GlobalReplicationGroup.Builder globalNodeGroups(Consumer<GlobalNodeGroup.Builder>... globalNodeGroups)

Indicates the slot configuration and global identifier for each slice group.

This is a convenience method that creates an instance of the GlobalNodeGroup.Builder avoiding the need to create one manually via GlobalNodeGroup.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #globalNodeGroups(List).

Parameters:

globalNodeGroups - a consumer that will call methods on GlobalNodeGroup.Builder

Returns:

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

See Also:

#globalNodeGroups(java.util.Collection)

authTokenEnabled

GlobalReplicationGroup.Builder authTokenEnabled(Boolean authTokenEnabled)

A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.

Default: false

Parameters:

authTokenEnabled - A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.

Default: false

Returns:

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

transitEncryptionEnabled

GlobalReplicationGroup.Builder transitEncryptionEnabled(Boolean transitEncryptionEnabled)

A flag that enables in-transit encryption when set to true.

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

Parameters:

transitEncryptionEnabled - A flag that enables in-transit encryption when set to true.

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

Returns:

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

atRestEncryptionEnabled

GlobalReplicationGroup.Builder atRestEncryptionEnabled(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 OSS 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 OSS version 3.2.6, 4.x or later.

Returns:

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

arn

GlobalReplicationGroup.Builder arn(String arn)

The ARN (Amazon Resource Name) of the global replication group.

Parameters:

arn - The ARN (Amazon Resource Name) of the global replication group.

Returns:

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