AWSKinesisStreamDescription

Objective-C

@interface AWSKinesisStreamDescription

Swift

class AWSKinesisStreamDescription

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.

    Declaration

    Objective-C

    @property (nonatomic) AWSKinesisEncryptionType encryptionType;

    Swift

    var encryptionType: AWSKinesisEncryptionType { get set }

  • Represents the current enhanced monitoring settings of the stream.

    Declaration

    Objective-C

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

    Swift

    var enhancedMonitoring: [AWSKinesisEnhancedMetrics]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable hasMoreShards;

    Swift

    var hasMoreShards: NSNumber? { get set }

  • 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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable keyId;

    Swift

    var keyId: String? { get set }

  • The current retention period, in hours.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable retentionPeriodHours;

    Swift

    var retentionPeriodHours: NSNumber? { get set }

  • The shards that comprise the stream.

    Declaration

    Objective-C

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

    Swift

    var shards: [AWSKinesisShard]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable streamARN;

    Swift

    var streamARN: String? { get set }

  • The approximate time that the stream was created.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable streamCreationTimestamp;

    Swift

    var streamCreationTimestamp: Date? { get set }

  • The name of the stream being described.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable streamName;

    Swift

    var streamName: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSKinesisStreamStatus streamStatus;

    Swift

    var streamStatus: AWSKinesisStreamStatus { get set }