AWS kinesisvideostreams-webrtc-dg documentation change
Summary
Updated documentation for IPv6/Dual-Stack support in Amazon Kinesis Video WebRTC. Changes include service name updates from 'Kinesis Video Streams' to 'Kinesis Video WebRTC', simplified SDK configuration instructions (especially for C SDK), removal of Java/GStreamer examples, updated API references (GetSignalingChannelEndpoint instead of GetDataEndpoint), and revised troubleshooting/consideration sections specific to WebRTC operations.
Security assessment
The changes focus on IPv6 feature implementation and service rebranding without addressing vulnerabilities. No evidence of security patches, vulnerability disclosures, or incident responses. Updates include configuration simplifications and API alignment for WebRTC, but lack security-specific content like authentication changes, encryption updates, or vulnerability mitigations.
Diff
diff --git a/kinesisvideostreams-webrtc-dg/latest/devguide/kvswebrtc-ipv6.md b/kinesisvideostreams-webrtc-dg/latest/devguide/kvswebrtc-ipv6.md index 6166704ea..78d93aa24 100644 --- a//kinesisvideostreams-webrtc-dg/latest/devguide/kvswebrtc-ipv6.md +++ b//kinesisvideostreams-webrtc-dg/latest/devguide/kvswebrtc-ipv6.md @@ -5 +5 @@ -Configure the Amazon Web Services SDK for IPv6Configure the Kinesis Video Streams Producer SDK for IPv6Configure the AWS CLI for IPv6Configuration examplesConsiderationsCustomers impacted by the upgrade to include IPv6Troubleshooting +Configure the Amazon Web Services SDK for IPv6-Dual-Stack EndpointsConfigure the Kinesis Video WebRTC SDK for IPv6/Dual-Stack EndpointsConfigure the WebRTC C SDKData plane endpoint resolutionConfigure the AWS CLI for IPv6/Dual-StackConsiderationsCustomers impacted by the upgrade to include IPv6Troubleshooting @@ -7 +7 @@ Configure the Amazon Web Services SDK for IPv6Configure the Kinesis Video Stream -# Use IPv6 with Amazon Kinesis Video Streams +# Use IPv6/Dual-Stack endpoints with Amazon Kinesis Video WebRTC @@ -9 +9 @@ Configure the Amazon Web Services SDK for IPv6Configure the Kinesis Video Stream -You can configure Amazon Kinesis Video Streams to use IPv6 for both control plane and data plane operations. This enables your applications to communicate with Kinesis Video Streams services using IPv6 addresses through dual-stack endpoints. +You can configure Amazon Kinesis Video WebRTC to use IPv6 for both control plane and data plane operations. This enables your applications to communicate with Kinesis Video WebRTC services using IPv6 addresses through dual-stack endpoints. @@ -13 +13 @@ You can configure Amazon Kinesis Video Streams to use IPv6 for both control plan -IPv6 support requires specific SDK versions and configuration settings. Ensure that your Kinesis Video Streams SDK and Amazon Web Services SDK versions support IPv6 dual-stack endpoints. Dual-stack endpoints support both IPv4 and IPv6 traffic and are available for some services in some Regions. +IPv6 support requires specific SDK versions and configuration settings. Ensure that your Kinesis Video WebRTC SDK and Amazon Web Services SDK versions support IPv6 dual-stack endpoints. Dual-stack endpoints support both IPv4 and IPv6 traffic and are available for some services in some Region. @@ -15 +15 @@ IPv6 support requires specific SDK versions and configuration settings. Ensure t -Amazon Kinesis Video Streams supports IPv6 through dual-stack endpoints for both producer and consumer applications. You can configure your applications to use IPv6 for control plane API calls and data plane streaming operations. +Amazon Kinesis Video WebRTC supports IPv6 through dual-stack endpoints for both master and viewer applications. You can configure your applications to use IPv6/Dual-Stack endpoints for control plane API calls and data plane operations. @@ -17 +17 @@ Amazon Kinesis Video Streams supports IPv6 through dual-stack endpoints for both -## Configure the Amazon Web Services SDK for IPv6 +## Configure the Amazon Web Services SDK for IPv6-Dual-Stack Endpoints @@ -19 +19 @@ Amazon Kinesis Video Streams supports IPv6 through dual-stack endpoints for both -If you're using the Amazon Web Services SDK to call Kinesis Video Streams control plane APIs in your production setup, you can enable IPv6 by configuring dual-stack endpoints. The Amazon Web Services SDK provides several standardized methods to enable dual-stack endpoints. +If you're using the Amazon Web Services SDK to call Kinesis Video WebRTC control plane APIs in your production setup, you can enable IPv6 by configuring dual-stack endpoints. The Amazon Web Services SDK provides several standardized methods to enable dual-stack endpoints. @@ -77 +77 @@ Tools for PowerShell V4 | Yes | Environment variable, configuration file -After you configure dual-stack endpoints, the Amazon Web Services SDK automatically uses IPv6 endpoints when calling Kinesis Video Streams control plane APIs. +After you configure dual-stack endpoints, the Amazon Web Services SDK automatically uses IPv6 endpoints when calling Kinesis Video WebRTC control plane APIs. @@ -79 +79 @@ After you configure dual-stack endpoints, the Amazon Web Services SDK automatica -## Configure the Kinesis Video Streams Producer SDK for IPv6 +## Configure the Kinesis Video WebRTC SDK for IPv6/Dual-Stack Endpoints @@ -81 +81 @@ After you configure dual-stack endpoints, the Amazon Web Services SDK automatica -The Kinesis Video Streams Producer SDK provides IPv6 configuration options for both control plane and data plane operations. These settings work with the Amazon Web Services SDK dual-stack endpoint configuration. +The Kinesis Video WebRTC SDK provides dual-stack configuration options for both control plane and data plane operations. These settings work with the Amazon Web Services SDK dual-stack endpoint configuration. @@ -83 +83 @@ The Kinesis Video Streams Producer SDK provides IPv6 configuration options for b -### Configure the C/C++ Producer SDK +## Configure the WebRTC C SDK @@ -85 +85 @@ The Kinesis Video Streams Producer SDK provides IPv6 configuration options for b -To enable IPv6 in the C/C++ Producer SDK: +To use dual-stack AWS KVS endpoints and attempt to gather IPv6 ICE candidates, set the following environment variable: @@ -87 +86,0 @@ To enable IPv6 in the C/C++ Producer SDK: - 1. **Configure the Amazon Web Services SDK for dual-stack** @@ -89 +88 @@ To enable IPv6 in the C/C++ Producer SDK: -First, ensure that dual-stack endpoints are enabled using one of the methods described previously. + export KVS_DUALSTACK_ENDPOINTS=ON @@ -91 +90 @@ First, ensure that dual-stack endpoints are enabled using one of the methods des - 2. **Set the IPv6 configuration flag** +In dual-stack mode, ICE gathering will attempt to include IPv6 candidates, but compatibility ultimately depends on the local network configuration and the capabilities of the receiving peers. @@ -93 +92 @@ First, ensure that dual-stack endpoints are enabled using one of the methods des -Configure the client info structure to enable IPv6: +To disable dual-stack mode, unset the environment variable: @@ -95,3 +93,0 @@ Configure the client info structure to enable IPv6: - ClientInfo clientInfo; - // ... other configuration ... - clientInfo.useIPv6 = TRUE; @@ -99 +95 @@ Configure the client info structure to enable IPv6: - 3. **URL construction** + unset KVS_DUALSTACK_ENDPOINTS @@ -101 +97 @@ Configure the client info structure to enable IPv6: -The SDK automatically constructs IPv6 dual-stack endpoints for the control plane when IPv6 is enabled. +## Data plane endpoint resolution @@ -103,46 +99 @@ The SDK automatically constructs IPv6 dual-stack endpoints for the control plane - 4. **cURL configuration** - -The SDK might set CURLOPT_IPRESOLVE to choose between IPv4 and IPv6 resolution based on your configuration. - - - - -### Configure the Java Producer SDK - -To enable IPv6 in the Java Producer SDK: - - 1. **Configure the Amazon Web Services SDK for dual-stack** - -Set the dual-stack endpoint configuration: - - // Using JVM system property - System.setProperty("aws.useDualstackEndpoint", "true"); - - // Or using environment variable before starting the application - // export AWS_USE_DUALSTACK_ENDPOINT=true - - 2. **Set the Kinesis Video Streams IPv6 configuration** - - System.setProperty("kvs.useIPv6", "true"); - - 3. **Client configuration** - -The SDK constructs appropriate IPv6 URLs in the Java layer when IPv6 is enabled. - - - - -### Configure the GStreamer plugin - -The GStreamer plugin uses the underlying C Producer SDK, so IPv6 configuration is handled automatically when you: - - * Configure the Amazon Web Services SDK for dual-stack endpoints - - * Configure the C SDK for IPv6 as described previously - - - - -### Data plane endpoint resolution - -For data plane operations, the Kinesis Video Streams SDK uses the GetDataEndpoint API to retrieve the appropriate IPv6 data plane endpoint. The SDK automatically requests IPv6 endpoints when IPv6 is configured. +For data plane operations, the Kinesis Video WebRTC SDK uses the GetSignalingChannelEndpoint API to retrieve the appropriate IPv6/Dual-stack data plane endpoint. The SDK automatically requests IPv6/Dual-stack endpoints when IPv6/Dual-stack is configured. @@ -152 +103 @@ For data plane operations, the Kinesis Video Streams SDK uses the GetDataEndpoin -The GetDataEndpoint API has been updated to support IPv6 endpoints. Ensure that you're using a compatible SDK version that supports this functionality. +The GetSignalingChannelEndpoint API has been updated to support IPv6 endpoints. Ensure that you're using a compatible SDK version that supports this functionality. @@ -154 +105 @@ The GetDataEndpoint API has been updated to support IPv6 endpoints. Ensure that -## Configure the AWS CLI for IPv6 +## Configure the AWS CLI for IPv6/Dual-Stack @@ -156 +107 @@ The GetDataEndpoint API has been updated to support IPv6 endpoints. Ensure that -If you're using the AWS CLI for Kinesis Video Streams operations (typically for proof-of-concept work), you can enable IPv6 by configuring dual-stack endpoints. +If you're using the AWS CLI for Kinesis Video WebRTC operations (typically for proof-of-concept work), you can enable IPv6 by configuring dual-stack endpoints. @@ -171,81 +122 @@ Add the following to your AWS CLI configuration file (~/.aws/config): -After you configure dual-stack endpoints, the AWS CLI uses IPv6 dual-stack endpoints for all Amazon Web Services calls, including Kinesis Video Streams operations. - -## Configuration examples - -### C SDK example - - - #include "KinesisVideoProducer.h" - - int main() { - // First, ensure Amazon Web Services SDK is configured for dual-stack - // This can be done via environment variable: - // export AWS_USE_DUALSTACK_ENDPOINT=true - - ClientInfo clientInfo; - - // Basic configuration - STRCPY(clientInfo.clientId, "MyKVSClient"); - clientInfo.clientInfo.version = CLIENT_INFO_CURRENT_VERSION; - - // Enable IPv6 for Kinesis Video Streams SDK - clientInfo.useIPv6 = TRUE; - - // Create Kinesis Video Streams client - PKinesisVideoClient pKinesisVideoClient; - STATUS status = createKinesisVideoClient(clientInfo, pKinesisVideoClient); - - if (STATUS_FAILED(status)) { - printf("Failed to create Kinesis Video Streams client with IPv6\n"); - return -1; - } - - // Continue with stream creation and data ingestion... - - return 0; - } - -### Java SDK example - - - import com.amazonaws.kinesisvideo.client.KinesisVideoClient; - import com.amazonaws.kinesisvideo.client.KinesisVideoClientConfiguration; - - public class KVSIPv6Example { - public static void main(String[] args) { - // Enable dual-stack endpoints for Amazon Web Services SDK - System.setProperty("aws.useDualstackEndpoint", "true"); - - // Enable IPv6 for Kinesis Video Streams SDK - System.setProperty("kvs.useIPv6", "true"); - - // Create Kinesis Video Streams client configuration - KinesisVideoClientConfiguration configuration = - KinesisVideoClientConfiguration.builder() - .withRegion("us-west-2") - .withCredentialsProvider(/* your credentials provider */) - .build(); - - // Create Kinesis Video Streams client - KinesisVideoClient kvsClient = KinesisVideoClient.builder() - .withConfiguration(configuration) - .build(); - - // Continue with stream operations... - } - } - -### Python (Boto3) example - - - import os - import boto3 - - # Configure dual-stack endpoints - os.environ['AWS_USE_DUALSTACK_ENDPOINT'] = 'true' - - # Create Kinesis Video Streams client - kvs_client = boto3.client('kinesisvideo', region_name='us-west-2') - - # The client now uses IPv6 dual-stack endpoints - response = kvs_client.list_streams()