Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Use IPv6 with Kinesis Video Streams

You can configure 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.

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.

Configure the Amazon SDK for IPv6

If you're using the Amazon SDK to call Kinesis Video Streams control plane APIs in your production setup, you can enable IPv6 by configuring dual-stack endpoints. The Amazon SDK provides several standardized methods to enable dual-stack endpoints.

Use environment variables

Set the following environment variable to enable IPv6 dual-stack endpoints:

export AWS_USE_DUALSTACK_ENDPOINT=true

Use the Amazon configuration file

Add the following setting to your Amazon configuration file (~/.aws/config):

[default]
use_dualstack_endpoint = true

Use JVM system properties (Java and Kotlin SDKs only)

For Java and Kotlin applications, set the following JVM system property:

-Daws.useDualstackEndpoint=true

Or programmatically in your Java code:

System.setProperty("aws.useDualstackEndpoint", "true");

SDK support

The following Amazon SDKs support dual-stack endpoint configuration:

After you configure dual-stack endpoints, the Amazon SDK automatically uses IPv6 endpoints when calling Kinesis Video Streams control plane APIs.

Configure the Kinesis Video Streams Producer SDK for IPv6

The Kinesis Video Streams Producer SDK provides IPv6 configuration options for both control plane and data plane operations. These settings work with the Amazon SDK dual-stack endpoint configuration.

Configure the C/C++ Producer SDK

The default endpoints and DNS resolution chain is implemented by the KVS Producer-C SDK version 1.6.0. It sequentially checks each place where you can set the configuration for these parameters, and then selects the first one you set. The predefined sequence is as follows:

For more information about the Producer SDKs, see the Producer SDK for C, Producer SDK for C++, and Producer SDK related topics.

Endpoint Configuration

With 2, 3, and 4, the endpoint will be constructed based on the region provided to createAbstractDefaultCallbacksProvider.

DNS filtering

The KVS Producer SDK will set the appropriate CURLOPT_IPRESOLVE parameter depending on the configuration:

The C++ Producer SDK version 3.5.0 uses the Producer-C SDK 1.6.0 for the KVS API calls.

Configure the GStreamer plugin

The GStreamer plugin uses the underlying C Producer SDK, so IPv6 configuration is handled automatically when you configure the C SDK for IPv6 as described previously.

Modifying the code is not required, simply build the SDK with the CMake parameters or set the appropriate environment variables as described in the previous section.

Data plane endpoint resolution

For data plane operations, use the GetDataEndpoint API to retrieve the appropriate dual-stack data plane endpoint. The service returns the corresponding endpoint depending on the request URL.

Example:

Configure the Amazon CLI for IPv6

If you're using the Amazon CLI for Kinesis Video Streams operations (typically for proof-of-concept work), you can enable IPv6 by configuring dual-stack endpoints.

Use an environment variable

export AWS_USE_DUALSTACK_ENDPOINT=true

Use the Amazon configuration file

Add the following to your Amazon CLI configuration file (~/.aws/config):

[default]
use_dualstack_endpoint = true

Configuration examples

C SDK example

To build the KVS Producer-C SDK in IPV6-only mode and ignore environment variable configuration, use the following commands to build the SDK:

cmake .. -DAWS_KVS_USE_DUAL_STACK_ENDPOINT_ONLY=TRUE -DAWS_KVS_IPV6_ONLY=TRUE
make -j

Considerations

Network requirements

SDK compatibility

Testing and validation

Before you deploy IPv6-enabled Kinesis Video Streams applications to production:

Customers impacted by the upgrade to include IPv6

When you enable IPv6 for Kinesis Video Streams, there are several areas where you might need to update your existing configurations and policies to ensure continued functionality.

IAM policies and IP address filtering

If you use source IP address filtering in your IAM user policies, role policies, or resource-based policies, you need to update these policies to include IPv6 address ranges.

Example IAM policy update for IPv6:

{
  "Version": "2012-10-17",		 	 	 
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": "*",
      "Action": "kinesisvideo:*",
      "Resource": "*",
      "Condition": {
        "IpAddress": {
          "aws:SourceIp": [
            "192.0.2.0/24",
            "203.0.113.0/24",
            "2001:db8::/32"
          ]
        }
      }
    }
  ]
}

Logging and monitoring

IPv6 addresses have a different format than IPv4 addresses, which can impact your logging, monitoring, and analytics systems.

logs

logs will contain IPv6 addresses in the sourceIPAddress field when requests are made over IPv6. Update your log parsing tools and scripts to handle IPv6 address formats.

Example IPv6 address in logs:

{
  "sourceIPAddress": "2001:db8::1",
  "eventName": "CreateStream",
  "eventSource": "kinesisvideo.amazonaws.com"
}

Troubleshooting

Common issues

Verification steps

Configuration validation

You can verify your dual-stack endpoint configuration by checking: