SplitShardRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kinesis.model.SplitShardRequest

All Implemented Interfaces:

Serializable
```
public class SplitShardRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the SplitShard operation.
This operation splits a shard into two new shards in the stream, to increase the stream's capacity to ingest and transport data. SplitShard is called when there is a need to increase the overall capacity of stream because of an expected increase in the volume of data records being ingested.

SplitShard can also be used when a given shard appears to be approaching its maximum utilization, for example, when the set of producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call the SplitShard operation to increase stream capacity, so that more Amazon Kinesis applications can simultaneously read data from the stream for real-time processing.

The SplitShard operation requires that you specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might simply be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information about splitting shards, see the Amazon Kinesis Developer Guide .

You can use the DescribeStream operation to determine the shard ID and hash key values for the ShardToSplit and NewStartingHashKey parameters that are specified in the SplitShard request.

SplitShard is an asynchronous operation. Upon receiving a SplitShard request, Amazon Kinesis immediately returns a response and sets the stream status to UPDATING. After the operation is completed, Amazon Kinesis sets the stream status to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.

You can use DescribeStream to check the status of the stream, which is returned in StreamStatus . If the stream is in the ACTIVE state, you can call SplitShard . If a stream is in CREATING or UPDATING or DELETING states, then Amazon Kinesis returns a ResourceInUseException .

If the specified stream does not exist, Amazon Kinesis returns a ResourceNotFoundException . If you try to create more shards than are authorized for your account, you receive a LimitExceededException .

Note: The default limit for an AWS account is two shards per stream. If you need to create a stream with more than two shards, contact AWS Support to increase the limit on your account.

If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards or SplitShard, you will receive a LimitExceededException .

SplitShard has limit of 5 transactions per second per account.

See Also:
AmazonKinesis.splitShard(SplitShardRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

SplitShardRequest()

Constructors
Constructor and Description
`SplitShardRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getNewStartingHashKey()` A hash key value for the starting hash key of one of the child shards created by the split.
`String`	`getShardToSplit()` The shard ID of the shard to split.
`String`	`getStreamName()` The name of the stream for the shard split.
`int`	`hashCode()`
`void`	`setNewStartingHashKey(String newStartingHashKey)` A hash key value for the starting hash key of one of the child shards created by the split.
`void`	`setShardToSplit(String shardToSplit)` The shard ID of the shard to split.
`void`	`setStreamName(String streamName)` The name of the stream for the shard split.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`SplitShardRequest`	`withNewStartingHashKey(String newStartingHashKey)` A hash key value for the starting hash key of one of the child shards created by the split.
`SplitShardRequest`	`withShardToSplit(String shardToSplit)` The shard ID of the shard to split.
`SplitShardRequest`	`withStreamName(String streamName)` The name of the stream for the shard split.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SplitShardRequest
```
public SplitShardRequest()
```
- Method Detail
  - getStreamName
```
public String getStreamName()
```
    The name of the stream for the shard split.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    The name of the stream for the shard split.
  - setStreamName
```
public void setStreamName(String streamName)
```
    The name of the stream for the shard split.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    streamName - The name of the stream for the shard split.
  - withStreamName
```
public SplitShardRequest withStreamName(String streamName)
```
    The name of the stream for the shard split.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    streamName - The name of the stream for the shard split.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getShardToSplit
```
public String getShardToSplit()
```
    The shard ID of the shard to split.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    The shard ID of the shard to split.
  - setShardToSplit
```
public void setShardToSplit(String shardToSplit)
```
    The shard ID of the shard to split.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    shardToSplit - The shard ID of the shard to split.
  - withShardToSplit
```
public SplitShardRequest withShardToSplit(String shardToSplit)
```
    The shard ID of the shard to split.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    shardToSplit - The shard ID of the shard to split.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getNewStartingHashKey
```
public String getNewStartingHashKey()
```
    A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for NewStartingHashKey must be in the range of hash keys being mapped into the shard. The NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.
    Constraints:
    Pattern: 0|([1-9]\d{0,38})
    
    Returns:
    A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for NewStartingHashKey must be in the range of hash keys being mapped into the shard. The NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.
  - setNewStartingHashKey
```
public void setNewStartingHashKey(String newStartingHashKey)
```
    A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for NewStartingHashKey must be in the range of hash keys being mapped into the shard. The NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.
    Constraints:
    Pattern: 0|([1-9]\d{0,38})
    
    Parameters:
    newStartingHashKey - A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for NewStartingHashKey must be in the range of hash keys being mapped into the shard. The NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.
  - withNewStartingHashKey
```
public SplitShardRequest withNewStartingHashKey(String newStartingHashKey)
```
    A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for NewStartingHashKey must be in the range of hash keys being mapped into the shard. The NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: 0|([1-9]\d{0,38})
    
    Parameters:
    newStartingHashKey - A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for NewStartingHashKey must be in the range of hash keys being mapped into the shard. The NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class SplitShardRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

SplitShardRequest

Method Detail

getStreamName

setStreamName

withStreamName

getShardToSplit

setShardToSplit

withShardToSplit

getNewStartingHashKey

setNewStartingHashKey

withNewStartingHashKey

toString

hashCode

equals