public class CreateStreamRequest extends AmazonWebServiceRequest implements Serializable
Creates an Amazon Kinesis stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.
You specify and control the number of shards that a stream is composed of. Each shard can support reads up to 5 transactions per second, up to a maximum data read total of 2 MB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB 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 Streams Limits in the Amazon Kinesis Streams Developer Guide. 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.
Constructor and Description |
---|
CreateStreamRequest() |
Modifier and Type | Method and Description |
---|---|
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.
|
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getStreamName()
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.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
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 void setStreamName(String 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.
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)
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.
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()
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;
Constraints:
Range: 1 - 100000
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 void setShardCount(Integer 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;
Constraints:
Range: 1 - 100000
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)
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;
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 - 100000
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()
Copyright © 2017. All rights reserved.