AWS kinesisvideostreams documentation change
Summary
Added example sections for each parameter in the GStreamer plugin parameters table and added example sections after the table and credentials section.
Security assessment
Changes are purely documentation formatting improvements and example additions. No security vulnerabilities, fixes, or new security features are mentioned or addressed.
Diff
diff --git a/kinesisvideostreams/latest/dg/examples-gstreamer-plugin-parameters.md b/kinesisvideostreams/latest/dg/examples-gstreamer-plugin-parameters.md index 436b2f332..84165468a 100644 --- a//kinesisvideostreams/latest/dg/examples-gstreamer-plugin-parameters.md +++ b//kinesisvideostreams/latest/dg/examples-gstreamer-plugin-parameters.md @@ -32,6 +32,32 @@ Key | Required | Description -`ca-path` | Yes | File path to the CA certificate used to establish trust with the backend service through TLS. **Example:** ` /`file`/`path`/`to`/certificate.pem` -`cert-path` | Yes | File path to the X.509 certificate. **Example:** `/`file`/`path`/`to`/`certificateID`-certificate.pem.crt` -`endpoint` | Yes | The AWS IoT Core credential endpoint provider endpoint for your AWS account. See the [AWS IoT Developer Guide](https://docs.aws.amazon.com//iot/latest/developerguide/authorizing-direct-aws.html). **Example:** ``credential-account-specific-prefix`.credentials.iot.`aws-region`.amazonaws.com` -`key-path` | Yes | File path to the private key used in the public/private key pair. **Example:** `/`file`/`path`/`to`/`certificateID`-private.pem.key` -`role-aliases` | Yes | The name of the role alias pointing to the AWS IAM role to use when connecting to AWS IoT Core. **Example:** ``KvsCameraIoTRoleAlias`` -`iot-thing-name` | No | The `iot-thing-name` is optional. If `iot-thing-name` is not provided, the `stream-name` parameter value is used. **Example:** ``kvs_example_camera`` +`ca-path` | Yes | File path to the CA certificate used to establish trust with the backend service through TLS. + +###### Example + +**Example:** ` /`file`/`path`/`to`/certificate.pem` +`cert-path` | Yes | File path to the X.509 certificate. + +###### Example + +**Example:** `/`file`/`path`/`to`/`certificateID`-certificate.pem.crt` +`endpoint` | Yes | The AWS IoT Core credential endpoint provider endpoint for your AWS account. See the [AWS IoT Developer Guide](https://docs.aws.amazon.com//iot/latest/developerguide/authorizing-direct-aws.html). + +###### Example + +**Example:** ``credential-account-specific-prefix`.credentials.iot.`aws-region`.amazonaws.com` +`key-path` | Yes | File path to the private key used in the public/private key pair. + +###### Example + +**Example:** `/`file`/`path`/`to`/`certificateID`-private.pem.key` +`role-aliases` | Yes | The name of the role alias pointing to the AWS IAM role to use when connecting to AWS IoT Core. + +###### Example + +**Example:** ``KvsCameraIoTRoleAlias`` +`iot-thing-name` | No | The `iot-thing-name` is optional. If `iot-thing-name` is not provided, the `stream-name` parameter value is used. + +###### Example + +**Example:** ``kvs_example_camera`` + +###### Example @@ -61,0 +88,2 @@ To specify credentials directly as a `kvssink` parameter, set the following para +###### Example + @@ -66,0 +95,2 @@ To specify credentials directly as a `kvssink` parameter, set the following para +###### Example + @@ -88,0 +119,2 @@ The text file must contain credentials in one of the following formats: +###### Example +