StreamDescription

public struct StreamDescription : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • 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

    Swift

    public let encryptionType: EncryptionType?

  • Represents the current enhanced monitoring settings of the stream.

    Declaration

    Swift

    public let enhancedMonitoring: [EnhancedMetrics]

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

    Declaration

    Swift

    public let hasMoreShards: Bool

  • 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

    Swift

    public let keyId: String?

  • The current retention period, in hours. Minimum value of 24. Maximum value of 168.

    Declaration

    Swift

    public let retentionPeriodHours: Int

  • The shards that comprise the stream.

    Declaration

    Swift

    public let shards: [Shard]

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

    Declaration

    Swift

    public let streamARN: String

  • The approximate time that the stream was created.

    Declaration

    Swift

    public let streamCreationTimestamp: TimeStamp

  • The name of the stream being described.

    Declaration

    Swift

    public let streamName: String

  • 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

    Swift

    public let streamStatus: StreamStatus

  • Undocumented

    Declaration

    Swift

    public init(encryptionType: EncryptionType? = nil, enhancedMonitoring: [EnhancedMetrics], hasMoreShards: Bool, keyId: String? = nil, retentionPeriodHours: Int, shards: [Shard], streamARN: String, streamCreationTimestamp: TimeStamp, streamName: String, streamStatus: StreamStatus)