public class SplitShardRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
SplitShard 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.
You can also use SplitShard
when a 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
SplitShard
to increase stream capacity, so that more
Amazon Kinesis applications can simultaneously read data from the
stream for real-time processing.
You must 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 Split a Shard in the Amazon Kinesis Developer Guide .
You can use DescribeStream 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,
DescribeStream
returns a
ResourceInUseException
.
If the specified stream does not exist, DescribeStream
returns a ResourceNotFoundException
. If you try to
create more shards than are authorized for your account, you receive a
LimitExceededException
.
For the default shard limit for an AWS account, see Amazon Kinesis Limits . If you need to increase this limit, contact AWS Support
If you try to operate on too many streams in parallel using
CreateStream, DeleteStream, MergeShards or SplitShard, you receive a
LimitExceededException
.
SplitShard
has limit of 5 transactions per second per
account.
NOOP
Constructor and Description |
---|
SplitShardRequest() |
Modifier and Type | Method and Description |
---|---|
SplitShardRequest |
clone() |
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.
|
copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getStreamName()
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
public void setStreamName(String streamName)
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
streamName
- The name of the stream for the shard split.public SplitShardRequest withStreamName(String streamName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
streamName
- The name of the stream for the shard split.public String getShardToSplit()
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
public void setShardToSplit(String shardToSplit)
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
shardToSplit
- The shard ID of the shard to split.public SplitShardRequest withShardToSplit(String shardToSplit)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
shardToSplit
- The shard ID of the shard to split.public String getNewStartingHashKey()
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})
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.public void setNewStartingHashKey(String newStartingHashKey)
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})
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.public SplitShardRequest withNewStartingHashKey(String newStartingHashKey)
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})
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.public String toString()
toString
in class Object
Object.toString()
public SplitShardRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2015. All rights reserved.