AWSKinesisStreamDescription Class Reference

Inherits from AWSModel : AWSMTLModel
Declared in AWSKinesisModel.h
AWSKinesisModel.m

Overview

Represents the output for DescribeStream.

Required parameters: [StreamName, StreamARN, StreamStatus, Shards, HasMoreShards, RetentionPeriodHours, EnhancedMonitoring]

  enhancedMonitoring

Represents the current enhanced monitoring settings of the stream.

@property (nonatomic, strong) NSArray<AWSKinesisEnhancedMetrics*> *enhancedMonitoring

Declared In

AWSKinesisModel.h

  hasMoreShards

If set to true, more shards in the stream are available to describe.

@property (nonatomic, strong) NSNumber *hasMoreShards

Declared In

AWSKinesisModel.h

  retentionPeriodHours

The current retention period, in hours.

@property (nonatomic, strong) NSNumber *retentionPeriodHours

Declared In

AWSKinesisModel.h

  shards

The shards that comprise the stream.

@property (nonatomic, strong) NSArray<AWSKinesisShard*> *shards

Declared In

AWSKinesisModel.h

  streamARN

The Amazon Resource Name (ARN) for the stream being described.

@property (nonatomic, strong) NSString *streamARN

Declared In

AWSKinesisModel.h

  streamName

The name of the stream being described.

@property (nonatomic, strong) NSString *streamName

Declared In

AWSKinesisModel.h

  streamStatus

The current status of the stream being described. The stream status is one of the following states:

  • CREATING - The stream is being created. Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
  • DELETING - The stream is being deleted. The specified stream is in the DELETING state until Amazon Kinesis completes the deletion.
  • ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.
  • UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.
@property (nonatomic, assign) AWSKinesisStreamStatus streamStatus

Declared In

AWSKinesisModel.h