kinesis_stream

Gets an individual kinesis_stream resource

Overview

Name	kinesis_stream
Type	Resource
Description	kinesis_stream
Id	awscc.kinesis.kinesis_stream

Fields

Name	Datatype	Description
stream_mode_details	object	The mode in which the stream is running.
stream_encryption	object	When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
arn	string	The Amazon resource name (ARN) of the Kinesis stream
retention_period_hours	integer	The number of hours for the data records that are stored in shards to remain accessible.
tags	array	An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
name	string	The name of the Kinesis stream.
shard_count	integer	The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
stream_mode_details,
stream_encryption,
arn,
retention_period_hours,
tags,
name,
shard_count
FROM awscc.kinesis.kinesis_stream
WHERE data__Identifier = '<Name>';

Permissions

To operate on the kinesis_stream resource, the following permissions are required:

Read

kinesis:DescribeStreamSummary,
kinesis:ListTagsForStream

Update

kinesis:EnableEnhancedMonitoring,
kinesis:DisableEnhancedMonitoring,
kinesis:DescribeStreamSummary,
kinesis:UpdateShardCount,
kinesis:UpdateStreamMode,
kinesis:IncreaseStreamRetentionPeriod,
kinesis:DecreaseStreamRetentionPeriod,
kinesis:StartStreamEncryption,
kinesis:StopStreamEncryption,
kinesis:AddTagsToStream,
kinesis:RemoveTagsFromStream,
kinesis:ListTagsForStream

Delete

kinesis:DescribeStreamSummary,
kinesis:DeleteStream,
kinesis:RemoveTagsFromStream