stream_storage_configurations

Creates, updates, deletes, gets or lists a stream_storage_configurations resource.

Overview

Name	stream_storage_configurations
Type	Resource
Id	aws.kinesisvideo.stream_storage_configurations

Fields

The following fields are returned by SELECT queries:

describe_stream_storage_configuration

Name	Datatype	Description
stream_arn	string	The Amazon Resource Name (ARN) of the stream. (pattern: <code>arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+</code>)
stream_name	string	The name of the stream. (pattern: <code>[a-zA-Z0-9_.-]+</code>)
stream_storage_configuration	object	The configuration for stream storage, including the default storage tier for stream data. This configuration determines how stream data is stored and accessed, with different tiers offering varying levels of performance and cost optimization.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_stream_storage_configuration	select	region		Retrieves the current storage configuration for the specified Kinesis video stream. In the request, you must specify either the StreamName or the StreamARN. You must have permissions for the KinesisVideo:DescribeStreamStorageConfiguration action.
update_stream_storage_configuration	update	region, CurrentVersion, StreamStorageConfiguration		Updates the storage configuration for an existing Kinesis video stream. This operation allows you to modify the storage tier settings for a stream, enabling you to optimize storage costs and performance based on your access patterns. UpdateStreamStorageConfiguration is an asynchronous operation. You must have permissions for the KinesisVideo:UpdateStreamStorageConfiguration action.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_stream_storage_configuration

Retrieves the current storage configuration for the specified Kinesis video stream. In the request, you must specify either the StreamName or the StreamARN. You must have permissions for the KinesisVideo:DescribeStreamStorageConfiguration action.

SELECT
stream_arn,
stream_name,
stream_storage_configuration
FROM aws.kinesisvideo.stream_storage_configurations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_stream_storage_configuration

Updates the storage configuration for an existing Kinesis video stream. This operation allows you to modify the storage tier settings for a stream, enabling you to optimize storage costs and performance based on your access patterns. UpdateStreamStorageConfiguration is an asynchronous operation. You must have permissions for the KinesisVideo:UpdateStreamStorageConfiguration action.

UPDATE aws.kinesisvideo.stream_storage_configurations
SET 
StreamName = '{{ StreamName }}',
StreamARN = '{{ StreamARN }}',
CurrentVersion = '{{ CurrentVersion }}',
StreamStorageConfiguration = '{{ StreamStorageConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND CurrentVersion = '{{ CurrentVersion }}' --required
AND StreamStorageConfiguration = '{{ StreamStorageConfiguration }}' --required;