software.amazon.kinesis.leases

Enum LeaseAssignmentStrategy

java.lang.Object

java.lang.Enum<LeaseAssignmentStrategy>

software.amazon.kinesis.leases.LeaseAssignmentStrategy

All Implemented Interfaces:

Serializable, Comparable<LeaseAssignmentStrategy>

public enum LeaseAssignmentStrategy
extends Enum<LeaseAssignmentStrategy>

Enum defining the lease assignment strategy for the KCL.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LEASE_COUNT_BASED Lease count-based assignment.
WORKER_UTILIZATION_AWARE KCL v3 default strategy: Worker utilization-aware assignment.

Method Summary

Modifier and Type	Method and Description
static LeaseAssignmentStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static LeaseAssignmentStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WORKER_UTILIZATION_AWARE

public static final LeaseAssignmentStrategy WORKER_UTILIZATION_AWARE

KCL v3 default strategy: Worker utilization-aware assignment.

Uses advanced algorithms that consider worker CPU, memory, and throughput metrics to make intelligent lease assignment decisions. Provides optimal load balancing for heterogeneous worker fleets and varying shard throughput.

Features: - Variance-based load balancing - Worker utilization metrics consideration - Dampening and gradual rebalancing - Throughput-aware assignment

LEASE_COUNT_BASED

public static final LeaseAssignmentStrategy LEASE_COUNT_BASED

Lease count-based assignment.

Uses simple lease count balancing where the goal is to distribute leases evenly across workers based purely on lease count, ignoring worker utilization metrics.

Method Detail

values

public static LeaseAssignmentStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LeaseAssignmentStrategy c : LeaseAssignmentStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LeaseAssignmentStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null