libZSservicesZSamazonka-kinesisZSamazonka-kinesis
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Kinesis.CreateStream

Description

Creates a Kinesis data 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 five transactions per second, up to a maximum data read total of 2 MiB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second. If the amount of data input increases or decreases, you can add or remove shards.

The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by AWS 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, Kinesis Data Streams immediately returns and sets the stream status to CREATING. After the stream is created, Kinesis Data Streams 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 when you try to do one of the following:

  • Have more than five streams in the CREATING state at any point in time.
  • Create more shards than are authorized for your account.

For the default shard limit for an AWS account, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. 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 five transactions per second per account.

Synopsis

Creating a Request

data CreateStream Source #

Represents the input for CreateStream.

See: newCreateStream smart constructor.

Constructors

CreateStream' 

Fields

  • streamName :: Text

    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 AWS Region. That is, two streams in two different AWS accounts can have the same name. Two streams in the same AWS account but in two different Regions can also have the same name.

  • shardCount :: Natural

    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.

Instances

Instances details
Eq CreateStream Source # 
Instance details

Defined in Amazonka.Kinesis.CreateStream

Read CreateStream Source # 
Instance details

Defined in Amazonka.Kinesis.CreateStream

Show CreateStream Source # 
Instance details

Defined in Amazonka.Kinesis.CreateStream

Generic CreateStream Source # 
Instance details

Defined in Amazonka.Kinesis.CreateStream

Associated Types

type Rep CreateStream :: Type -> Type #

NFData CreateStream Source # 
Instance details

Defined in Amazonka.Kinesis.CreateStream

Methods

rnf :: CreateStream -> () #

Hashable CreateStream Source # 
Instance details

Defined in Amazonka.Kinesis.CreateStream

ToJSON CreateStream Source # 
Instance details

Defined in Amazonka.Kinesis.CreateStream

AWSRequest CreateStream Source # 
Instance details

Defined in Amazonka.Kinesis.CreateStream

Associated Types

type AWSResponse CreateStream #

ToHeaders CreateStream Source # 
Instance details

Defined in Amazonka.Kinesis.CreateStream

ToPath CreateStream Source # 
Instance details

Defined in Amazonka.Kinesis.CreateStream

ToQuery CreateStream Source # 
Instance details

Defined in Amazonka.Kinesis.CreateStream

type Rep CreateStream Source # 
Instance details

Defined in Amazonka.Kinesis.CreateStream

type Rep CreateStream = D1 ('MetaData "CreateStream" "Amazonka.Kinesis.CreateStream" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "CreateStream'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "shardCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))
type AWSResponse CreateStream Source # 
Instance details

Defined in Amazonka.Kinesis.CreateStream

newCreateStream Source #

Create a value of CreateStream with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamName:CreateStream', createStream_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 AWS Region. That is, two streams in two different AWS accounts can have the same name. Two streams in the same AWS account but in two different Regions can also have the same name.

$sel:shardCount:CreateStream', createStream_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.

Request Lenses

createStream_streamName :: Lens' CreateStream Text Source #

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 AWS Region. That is, two streams in two different AWS accounts can have the same name. Two streams in the same AWS account but in two different Regions can also have the same name.

createStream_shardCount :: Lens' CreateStream Natural Source #

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.

Destructuring the Response

data CreateStreamResponse Source #

See: newCreateStreamResponse smart constructor.

Constructors

CreateStreamResponse' 

Instances

Instances details
Eq CreateStreamResponse Source # 
Instance details

Defined in Amazonka.Kinesis.CreateStream

Read CreateStreamResponse Source # 
Instance details

Defined in Amazonka.Kinesis.CreateStream

Show CreateStreamResponse Source # 
Instance details

Defined in Amazonka.Kinesis.CreateStream

Generic CreateStreamResponse Source # 
Instance details

Defined in Amazonka.Kinesis.CreateStream

Associated Types

type Rep CreateStreamResponse :: Type -> Type #

NFData CreateStreamResponse Source # 
Instance details

Defined in Amazonka.Kinesis.CreateStream

Methods

rnf :: CreateStreamResponse -> () #

type Rep CreateStreamResponse Source # 
Instance details

Defined in Amazonka.Kinesis.CreateStream

type Rep CreateStreamResponse = D1 ('MetaData "CreateStreamResponse" "Amazonka.Kinesis.CreateStream" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "CreateStreamResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newCreateStreamResponse :: CreateStreamResponse Source #

Create a value of CreateStreamResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.