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, StreamCreationTimestamp, EnhancedMonitoring]

  encryptionType

The server-side encryption type used on the stream. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

@property (nonatomic, assign) AWSKinesisEncryptionType encryptionType

Declared In

AWSKinesisModel.h

  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

  keyId

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

@property (nonatomic, strong) NSString *keyId

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

  streamCreationTimestamp

The approximate time that the stream was created.

@property (nonatomic, strong) NSDate *streamCreationTimestamp

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. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.

  • DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams 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