AWSKinesisStreamDescription Class Reference
|Inherits from||AWSModel : AWSMTLModel|
Represents the output for DescribeStream.
Required parameters: [StreamName, StreamARN, StreamStatus, Shards, HasMoreShards, RetentionPeriodHours, StreamCreationTimestamp, EnhancedMonitoring]
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
Represents the current enhanced monitoring settings of the stream.
@property (nonatomic, strong) NSArray<AWSKinesisEnhancedMetrics*> *enhancedMonitoring
If set to
true, more shards in the stream are available to describe.
@property (nonatomic, strong) NSNumber *hasMoreShards
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
Key ARN example:
Alias ARN example:
Globally unique key ID example:
Alias name example:
Master key owned by Kinesis Data Streams:
@property (nonatomic, strong) NSString *keyId
The current retention period, in hours.
@property (nonatomic, strong) NSNumber *retentionPeriodHours
The shards that comprise the stream.
@property (nonatomic, strong) NSArray<AWSKinesisShard*> *shards
The Amazon Resource Name (ARN) for the stream being described.
@property (nonatomic, strong) NSString *streamARN
The approximate time that the stream was created.
@property (nonatomic, strong) NSDate *streamCreationTimestamp
The name of the stream being described.
@property (nonatomic, strong) NSString *streamName
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
DELETING- The stream is being deleted. The specified stream is in the
DELETINGstate 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
UPDATING- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the
@property (nonatomic, assign) AWSKinesisStreamStatus streamStatus