Interface UpdateClusterRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<UpdateClusterRequest.Builder,UpdateClusterRequest>,MemoryDbRequest.Builder,SdkBuilder<UpdateClusterRequest.Builder,UpdateClusterRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- UpdateClusterRequest
public static interface UpdateClusterRequest.Builder extends MemoryDbRequest.Builder, SdkPojo, CopyableBuilder<UpdateClusterRequest.Builder,UpdateClusterRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description UpdateClusterRequest.BuilderaclName(String aclName)The Access Control List that is associated with the clusterUpdateClusterRequest.BuilderclusterName(String clusterName)The name of the cluster to updateUpdateClusterRequest.Builderdescription(String description)The description of the cluster to updateUpdateClusterRequest.BuilderengineVersion(String engineVersion)The upgraded version of the engine to be run on the nodes.UpdateClusterRequest.BuildermaintenanceWindow(String maintenanceWindow)Specifies the weekly time range during which maintenance on the cluster is performed.UpdateClusterRequest.BuildernodeType(String nodeType)A valid node type that you want to scale this cluster up or down to.UpdateClusterRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)UpdateClusterRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)UpdateClusterRequest.BuilderparameterGroupName(String parameterGroupName)The name of the parameter group to updatedefault UpdateClusterRequest.BuilderreplicaConfiguration(Consumer<ReplicaConfigurationRequest.Builder> replicaConfiguration)The number of replicas that will reside in each shardUpdateClusterRequest.BuilderreplicaConfiguration(ReplicaConfigurationRequest replicaConfiguration)The number of replicas that will reside in each shardUpdateClusterRequest.BuildersecurityGroupIds(String... securityGroupIds)The SecurityGroupIds to updateUpdateClusterRequest.BuildersecurityGroupIds(Collection<String> securityGroupIds)The SecurityGroupIds to updatedefault UpdateClusterRequest.BuildershardConfiguration(Consumer<ShardConfigurationRequest.Builder> shardConfiguration)The number of shards in the clusterUpdateClusterRequest.BuildershardConfiguration(ShardConfigurationRequest shardConfiguration)The number of shards in the clusterUpdateClusterRequest.BuildersnapshotRetentionLimit(Integer snapshotRetentionLimit)The number of days for which MemoryDB retains automatic cluster snapshots before deleting them.UpdateClusterRequest.BuildersnapshotWindow(String snapshotWindow)The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.UpdateClusterRequest.BuildersnsTopicArn(String snsTopicArn)The SNS topic ARN to updateUpdateClusterRequest.BuildersnsTopicStatus(String snsTopicStatus)The status of the Amazon SNS notification topic.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.memorydb.model.MemoryDbRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
clusterName
UpdateClusterRequest.Builder clusterName(String clusterName)
The name of the cluster to update
- Parameters:
clusterName- The name of the cluster to update- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
UpdateClusterRequest.Builder description(String description)
The description of the cluster to update
- Parameters:
description- The description of the cluster to update- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroupIds
UpdateClusterRequest.Builder securityGroupIds(Collection<String> securityGroupIds)
The SecurityGroupIds to update
- Parameters:
securityGroupIds- The SecurityGroupIds to update- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroupIds
UpdateClusterRequest.Builder securityGroupIds(String... securityGroupIds)
The SecurityGroupIds to update
- Parameters:
securityGroupIds- The SecurityGroupIds to update- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maintenanceWindow
UpdateClusterRequest.Builder maintenanceWindow(String maintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for
dddare:-
sun -
mon -
tue -
wed -
thu -
fri -
sat
Example:
sun:23:00-mon:01:30- Parameters:
maintenanceWindow- Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.Valid values for
dddare:-
sun -
mon -
tue -
wed -
thu -
fri -
sat
Example:
sun:23:00-mon:01:30-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
snsTopicArn
UpdateClusterRequest.Builder snsTopicArn(String snsTopicArn)
The SNS topic ARN to update
- Parameters:
snsTopicArn- The SNS topic ARN to update- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snsTopicStatus
UpdateClusterRequest.Builder snsTopicStatus(String snsTopicStatus)
The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.
- Parameters:
snsTopicStatus- The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameterGroupName
UpdateClusterRequest.Builder parameterGroupName(String parameterGroupName)
The name of the parameter group to update
- Parameters:
parameterGroupName- The name of the parameter group to update- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotWindow
UpdateClusterRequest.Builder snapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
- Parameters:
snapshotWindow- The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotRetentionLimit
UpdateClusterRequest.Builder snapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which MemoryDB 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.
- Parameters:
snapshotRetentionLimit- The number of days for which MemoryDB 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nodeType
UpdateClusterRequest.Builder nodeType(String nodeType)
A valid node type that you want to scale this cluster up or down to.
- Parameters:
nodeType- A valid node type that you want to scale this cluster up or down to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engineVersion
UpdateClusterRequest.Builder engineVersion(String engineVersion)
The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine version, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.
- Parameters:
engineVersion- The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine version, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
replicaConfiguration
UpdateClusterRequest.Builder replicaConfiguration(ReplicaConfigurationRequest replicaConfiguration)
The number of replicas that will reside in each shard
- Parameters:
replicaConfiguration- The number of replicas that will reside in each shard- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
replicaConfiguration
default UpdateClusterRequest.Builder replicaConfiguration(Consumer<ReplicaConfigurationRequest.Builder> replicaConfiguration)
The number of replicas that will reside in each shard
This is a convenience method that creates an instance of theReplicaConfigurationRequest.Builderavoiding the need to create one manually viaReplicaConfigurationRequest.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toreplicaConfiguration(ReplicaConfigurationRequest).- Parameters:
replicaConfiguration- a consumer that will call methods onReplicaConfigurationRequest.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
replicaConfiguration(ReplicaConfigurationRequest)
-
shardConfiguration
UpdateClusterRequest.Builder shardConfiguration(ShardConfigurationRequest shardConfiguration)
The number of shards in the cluster
- Parameters:
shardConfiguration- The number of shards in the cluster- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
shardConfiguration
default UpdateClusterRequest.Builder shardConfiguration(Consumer<ShardConfigurationRequest.Builder> shardConfiguration)
The number of shards in the cluster
This is a convenience method that creates an instance of theShardConfigurationRequest.Builderavoiding the need to create one manually viaShardConfigurationRequest.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toshardConfiguration(ShardConfigurationRequest).- Parameters:
shardConfiguration- a consumer that will call methods onShardConfigurationRequest.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
shardConfiguration(ShardConfigurationRequest)
-
aclName
UpdateClusterRequest.Builder aclName(String aclName)
The Access Control List that is associated with the cluster
- Parameters:
aclName- The Access Control List that is associated with the cluster- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
UpdateClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
UpdateClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-