media_storage_configurations

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

Overview

Name	media_storage_configurations
Type	Resource
Id	aws.kinesisvideo.media_storage_configurations

Fields

The following fields are returned by SELECT queries:

describe_media_storage_configuration

Name	Datatype	Description
status	string	The status of the media storage configuration. (ENABLED, DISABLED)
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>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_media_storage_configuration	select	region		Returns the most current information about the channel. Specify the ChannelName or ChannelARN in the input.
update_media_storage_configuration	update	region, ChannelARN, MediaStorageConfiguration		Associates a SignalingChannel to a stream to store the media. There are two signaling modes that you can specify : If StorageStatus is enabled, the data will be stored in the StreamARN provided. In order for WebRTC Ingestion to work, the stream must have data retention enabled. If StorageStatus is disabled, no data will be stored, and the StreamARN parameter will not be needed. If StorageStatus is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call the JoinStorageSession API to trigger an SDP offer send and establish a connection between a peer and the storage session.

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_media_storage_configuration

Returns the most current information about the channel. Specify the ChannelName or ChannelARN in the input.

SELECT
status,
stream_arn
FROM aws.kinesisvideo.media_storage_configurations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_media_storage_configuration

Associates a SignalingChannel to a stream to store the media. There are two signaling modes that you can specify : If StorageStatus is enabled, the data will be stored in the StreamARN provided. In order for WebRTC Ingestion to work, the stream must have data retention enabled. If StorageStatus is disabled, no data will be stored, and the StreamARN parameter will not be needed. If StorageStatus is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call the JoinStorageSession API to trigger an SDP offer send and establish a connection between a peer and the storage session.

UPDATE aws.kinesisvideo.media_storage_configurations
SET 
ChannelARN = '{{ ChannelARN }}',
MediaStorageConfiguration = '{{ MediaStorageConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND ChannelARN = '{{ ChannelARN }}' --required
AND MediaStorageConfiguration = '{{ MediaStorageConfiguration }}' --required;