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

Interface DecreaseReplicaCountRequest.Builder

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

  • Method Details

    • replicationGroupId

      DecreaseReplicaCountRequest.Builder replicationGroupId(String replicationGroupId)

      The id of the replication group from which you want to remove replica nodes.

      Parameters:
      replicationGroupId - The id of the replication group from which you want to remove replica nodes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • newReplicaCount

      DecreaseReplicaCountRequest.Builder newReplicaCount(Integer newReplicaCount)

      The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

      The minimum number of replicas in a shard or replication group is:

      • Redis (cluster mode disabled)

        • If Multi-AZ is enabled: 1

        • If Multi-AZ is not enabled: 0

      • Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

      Parameters:
      newReplicaCount - The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

      The minimum number of replicas in a shard or replication group is:

      • Redis (cluster mode disabled)

        • If Multi-AZ is enabled: 1

        • If Multi-AZ is not enabled: 0

      • Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

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

    • replicaConfiguration

      DecreaseReplicaCountRequest.Builder replicaConfiguration(Collection<ConfigureShard> replicaConfiguration)

      A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

      Parameters:
      replicaConfiguration - A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • replicaConfiguration

      DecreaseReplicaCountRequest.Builder replicaConfiguration(ConfigureShard... replicaConfiguration)

      A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

      Parameters:
      replicaConfiguration - A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • replicaConfiguration

      DecreaseReplicaCountRequest.Builder replicaConfiguration(Consumer<ConfigureShard.Builder>... replicaConfiguration)

      A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

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

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

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

    • replicasToRemove

      DecreaseReplicaCountRequest.Builder replicasToRemove(Collection<String> replicasToRemove)

      A list of the node ids to remove from the replication group or node group (shard).

      Parameters:
      replicasToRemove - A list of the node ids to remove from the replication group or node group (shard).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • replicasToRemove

      DecreaseReplicaCountRequest.Builder replicasToRemove(String... replicasToRemove)

      A list of the node ids to remove from the replication group or node group (shard).

      Parameters:
      replicasToRemove - A list of the node ids to remove from the replication group or node group (shard).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • applyImmediately

      DecreaseReplicaCountRequest.Builder applyImmediately(Boolean applyImmediately)

      If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

      Parameters:
      applyImmediately - If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      DecreaseReplicaCountRequest.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

      DecreaseReplicaCountRequest.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.