Interface GlobalReplicationGroup.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<GlobalReplicationGroup.Builder,
,GlobalReplicationGroup> SdkBuilder<GlobalReplicationGroup.Builder,
,GlobalReplicationGroup> SdkPojo
- Enclosing class:
GlobalReplicationGroup
-
Method Summary
Modifier and TypeMethodDescriptionThe ARN (Amazon Resource Name) of the global replication group.atRestEncryptionEnabled
(Boolean atRestEncryptionEnabled) A flag that enables encryption at rest when set totrue
.authTokenEnabled
(Boolean authTokenEnabled) A flag that enables using anAuthToken
(password) when issuing Redis OSS commands.cacheNodeType
(String cacheNodeType) The cache node type of the Global datastoreclusterEnabled
(Boolean clusterEnabled) A flag that indicates whether the Global datastore is cluster enabled.The Elasticache engine.engineVersion
(String engineVersion) The Elasticache (Redis OSS) engine version.globalNodeGroups
(Collection<GlobalNodeGroup> globalNodeGroups) Indicates the slot configuration and global identifier for each slice group.globalNodeGroups
(Consumer<GlobalNodeGroup.Builder>... globalNodeGroups) Indicates the slot configuration and global identifier for each slice group.globalNodeGroups
(GlobalNodeGroup... globalNodeGroups) Indicates the slot configuration and global identifier for each slice group.globalReplicationGroupDescription
(String globalReplicationGroupDescription) The optional description of the Global datastoreglobalReplicationGroupId
(String globalReplicationGroupId) The name of the Global datastoremembers
(Collection<GlobalReplicationGroupMember> members) The replication groups that comprise the Global datastore.members
(Consumer<GlobalReplicationGroupMember.Builder>... members) The replication groups that comprise the Global datastore.members
(GlobalReplicationGroupMember... members) The replication groups that comprise the Global datastore.The status of the Global datastoretransitEncryptionEnabled
(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, sdkFields
-
Method Details
-
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
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
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
The Elasticache engine. For Redis OSS only.
- Parameters:
engine
- The Elasticache engine. For Redis OSS only.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engineVersion
The Elasticache (Redis OSS) engine version.
- Parameters:
engineVersion
- The Elasticache (Redis OSS) engine version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
The replication groups that comprise the Global datastore.
This is a convenience method that creates an instance of theGlobalReplicationGroupMember.Builder
avoiding the need to create one manually viaGlobalReplicationGroupMember.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomembers(List<GlobalReplicationGroupMember>)
.- Parameters:
members
- a consumer that will call methods onGlobalReplicationGroupMember.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theGlobalNodeGroup.Builder
avoiding the need to create one manually viaGlobalNodeGroup.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toglobalNodeGroups(List<GlobalNodeGroup>)
.- Parameters:
globalNodeGroups
- a consumer that will call methods onGlobalNodeGroup.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
authTokenEnabled
A flag that enables using an
AuthToken
(password) when issuing Redis OSS commands.Default:
false
- Parameters:
authTokenEnabled
- A flag that enables using anAuthToken
(password) when issuing Redis OSS commands.Default:
false
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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 setAtRestEncryptionEnabled
totrue
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 totrue
.You cannot modify the value of
AtRestEncryptionEnabled
after the replication group is created. To enable encryption at rest on a replication group you must setAtRestEncryptionEnabled
totrue
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
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.
-