aws_kinesis_stream
account_id
Type: STRING
consumer_count
Type: INT32
Provider name: ConsumerCount
Description: The number of enhanced fan-out consumers registered with the stream.
encryption_type
Type: STRING
Provider name: EncryptionType
Description: The encryption type used. This value is one of the following:
enhanced_monitoring
Type: UNORDERED_LIST_STRUCT
Provider name: EnhancedMonitoring
Description: Represents the current enhanced monitoring settings of the stream.
shard_level_metrics
Type: UNORDERED_LIST_STRING
Provider name: ShardLevelMetrics
Description: List of shard-level metrics. The following are the valid shard-level metrics. The value “ALL” enhances every metric.IncomingBytesIncomingRecordsOutgoingBytesOutgoingRecordsWriteProvisionedThroughputExceededReadProvisionedThroughputExceededIteratorAgeMillisecondsALL
For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.
key_id
Type: STRING
Provider name: KeyId
Description: The GUID for the customer-managed Amazon Web Services 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
open_shard_count
Type: INT32
Provider name: OpenShardCount
Description: The number of open shards in the stream.
retention_period_hours
Type: INT32
Provider name: RetentionPeriodHours
Description: The current retention period, in hours.
stream_arn
Type: STRING
Provider name: StreamARN
Description: The Amazon Resource Name (ARN) for the stream being described.
stream_creation_timestamp
Type: TIMESTAMP
Provider name: StreamCreationTimestamp
Description: The approximate time that the stream was created.
stream_mode_details
Type: STRUCT
Provider name: StreamModeDetails
Description: Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand ycapacity mode and a provisioned capacity mode for your data streams.
stream_mode
Type: STRING
Provider name: StreamMode
Description: Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.
stream_name
Type: STRING
Provider name: StreamName
Description: The name of the stream being described.
stream_status
Type: STRING
Provider name: StreamStatus
Description: 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.
Type: UNORDERED_LIST_STRING
