public class CreateStreamRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
CreateStream operation
.
Creates a Amazon Kinesis stream. A stream captures and transports data records that are continuously emitted from different data sources or producers . Scale-out within an Amazon Kinesis stream is explicitly supported by means of shards, which are uniquely identified groups of data records in an Amazon Kinesis stream.
You specify and control the number of shards that a stream is composed of. Each open shard can support up to 5 read transactions per second, up to a maximum total of 2 MB of data read per second. Each shard can support up to 1000 records written per second, up to a maximum total of 1 MB data written per second. You can add shards to a stream if the amount of data input increases and you can remove shards if the amount of data input decreases.
The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different regions, can have the same name.
CreateStream
is an asynchronous operation. Upon
receiving a CreateStream
request, Amazon Kinesis
immediately returns and sets the stream status to
CREATING
. After the stream is created, Amazon Kinesis
sets the stream status to ACTIVE
. You should perform
read and write operations only on an ACTIVE
stream.
You receive a LimitExceededException
when making a
CreateStream
request if you try to do one of the
following:
CREATING
state at
any point in time.For the default shard limit for an AWS account, see Amazon Kinesis Limits . If you need to increase this limit, contact AWS Support
You can use DescribeStream
to check the stream status,
which is returned in StreamStatus
.
CreateStream has a limit of 5 transactions per second per account.
NOOP
Constructor and Description |
---|
CreateStreamRequest() |
Modifier and Type | Method and Description |
---|---|
CreateStreamRequest |
clone() |
boolean |
equals(Object obj) |
Integer |
getShardCount()
The number of shards that the stream will use.
|
String |
getStreamName()
A name to identify the stream.
|
int |
hashCode() |
void |
setShardCount(Integer shardCount)
The number of shards that the stream will use.
|
void |
setStreamName(String streamName)
A name to identify the stream.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreateStreamRequest |
withShardCount(Integer shardCount)
The number of shards that the stream will use.
|
CreateStreamRequest |
withStreamName(String streamName)
A name to identify the stream.
|
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
- A name to identify the stream. The stream name is scoped to the AWS
account used by the application that creates the stream. It is also
scoped by region. That is, two streams in two different AWS accounts
can have the same name, and two streams in the same AWS account, but
in two different regions, can have the same name.public CreateStreamRequest 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
- A name to identify the stream. The stream name is scoped to the AWS
account used by the application that creates the stream. It is also
scoped by region. That is, two streams in two different AWS accounts
can have the same name, and two streams in the same AWS account, but
in two different regions, can have the same name.public Integer getShardCount()
DefaultShardLimit;
Constraints:
Range: 1 -
DefaultShardLimit;
public void setShardCount(Integer shardCount)
DefaultShardLimit;
Constraints:
Range: 1 -
shardCount
- The number of shards that the stream will use. The throughput of the
stream is a function of the number of shards; more shards are required
for greater provisioned throughput. DefaultShardLimit;
public CreateStreamRequest withShardCount(Integer shardCount)
DefaultShardLimit;
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 -
shardCount
- The number of shards that the stream will use. The throughput of the
stream is a function of the number of shards; more shards are required
for greater provisioned throughput. DefaultShardLimit;
public String toString()
toString
in class Object
Object.toString()
public CreateStreamRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2015. All rights reserved.