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

Interface ModifyReplicationGroupShardConfigurationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ModifyReplicationGroupShardConfigurationRequest.Builder,ModifyReplicationGroupShardConfigurationRequest>, ElastiCacheRequest.Builder, SdkBuilder<ModifyReplicationGroupShardConfigurationRequest.Builder,ModifyReplicationGroupShardConfigurationRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ModifyReplicationGroupShardConfigurationRequest
public static interface ModifyReplicationGroupShardConfigurationRequest.Builder extends ElastiCacheRequest.Builder, SdkPojo, CopyableBuilder<ModifyReplicationGroupShardConfigurationRequest.Builder,ModifyReplicationGroupShardConfigurationRequest>

  • Method Details

    • replicationGroupId

      ModifyReplicationGroupShardConfigurationRequest.Builder replicationGroupId(String replicationGroupId)

      The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.

      Parameters:
      replicationGroupId - The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nodeGroupCount

      ModifyReplicationGroupShardConfigurationRequest.Builder nodeGroupCount(Integer nodeGroupCount)

      The number of node groups (shards) that results from the modification of the shard configuration.

      Parameters:
      nodeGroupCount - The number of node groups (shards) that results from the modification of the shard configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • applyImmediately

      ModifyReplicationGroupShardConfigurationRequest.Builder applyImmediately(Boolean applyImmediately)

      Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

      Value: true

      Parameters:
      applyImmediately - Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

      Value: true

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

    • reshardingConfiguration

      ModifyReplicationGroupShardConfigurationRequest.Builder reshardingConfiguration(Collection<ReshardingConfiguration> reshardingConfiguration)

      Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you.

      You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).

      Parameters:
      reshardingConfiguration - Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you.

      You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).

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

    • reshardingConfiguration

      ModifyReplicationGroupShardConfigurationRequest.Builder reshardingConfiguration(ReshardingConfiguration... reshardingConfiguration)

      Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you.

      You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).

      Parameters:
      reshardingConfiguration - Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you.

      You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).

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

    • reshardingConfiguration

      ModifyReplicationGroupShardConfigurationRequest.Builder reshardingConfiguration(Consumer<ReshardingConfiguration.Builder>... reshardingConfiguration)

      Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you.

      You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to reshardingConfiguration(List<ReshardingConfiguration>).

      Parameters:
      reshardingConfiguration - a consumer that will call methods on ReshardingConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nodeGroupsToRemove

      ModifyReplicationGroupShardConfigurationRequest.Builder nodeGroupsToRemove(Collection<String> nodeGroupsToRemove)

      If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.

      ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

      Parameters:
      nodeGroupsToRemove - If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.

      ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

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

    • nodeGroupsToRemove

      ModifyReplicationGroupShardConfigurationRequest.Builder nodeGroupsToRemove(String... nodeGroupsToRemove)

      If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.

      ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

      Parameters:
      nodeGroupsToRemove - If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.

      ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

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

    • nodeGroupsToRetain

      ModifyReplicationGroupShardConfigurationRequest.Builder nodeGroupsToRetain(Collection<String> nodeGroupsToRetain)

      If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.

      ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

      Parameters:
      nodeGroupsToRetain - If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.

      ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

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

    • nodeGroupsToRetain

      ModifyReplicationGroupShardConfigurationRequest.Builder nodeGroupsToRetain(String... nodeGroupsToRetain)

      If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.

      ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

      Parameters:
      nodeGroupsToRetain - If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.

      ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

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

    • overrideConfiguration

      ModifyReplicationGroupShardConfigurationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ModifyReplicationGroupShardConfigurationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.