Class: Aws::ChimeSDKMediaPipelines::Types::KinesisVideoStreamConfiguration

Inherits:

Struct

Object
Struct
Aws::ChimeSDKMediaPipelines::Types::KinesisVideoStreamConfiguration

show all

Defined in:: gems/aws-sdk-chimesdkmediapipelines/lib/aws-sdk-chimesdkmediapipelines/types.rb

Overview

The configuration of an Kinesis video stream.

If a meeting uses an opt-in Region as its MediaRegion, the KVS stream must be in that same Region. For example, if a meeting uses the af-south-1 Region, the KVS stream must also be in af-south-1. However, if the meeting uses a Region that AWS turns on by default, the KVS stream can be in any available Region, including an opt-in Region. For example, if the meeting uses ca-central-1, the KVS stream can be in eu-west-2, us-east-1, af-south-1, or any other Region that the Amazon Chime SDK supports.

To learn which AWS Region a meeting uses, call the GetMeeting API and use the MediaRegion parameter from the response.

For more information about opt-in Regions, refer to Available Regions in the Amazon Chime SDK Developer Guide, and Specify which AWS Regions your account can use, in the AWS Account Management Reference Guide.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#data_retention_in_hours ⇒ Integer
The amount of time that data is retained.
#region ⇒ String
The Amazon Web Services Region of the video stream.

Instance Attribute Details

#data_retention_in_hours ⇒ `Integer`

The amount of time that data is retained.

Returns:

(Integer)

# File 'gems/aws-sdk-chimesdkmediapipelines/lib/aws-sdk-chimesdkmediapipelines/types.rb', line 1639

class KinesisVideoStreamConfiguration < Struct.new(
  :region,
  :data_retention_in_hours)
  SENSITIVE = []
  include Aws::Structure
end

#region ⇒ `String`

The Amazon Web Services Region of the video stream.