udpate docs for PKCS#11 (#221)

Author: graebm

docs/assets/js/search.json

@@ -105,6 +105,7 @@ <h3>Methods</h3>
 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="aws_iot.awsiotmqttconnectionconfigbuilder.html#with_will" class="tsd-kind-icon">with_<wbr>will</a></li>
 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="aws_iot.awsiotmqttconnectionconfigbuilder.html#new_mtls_builder" class="tsd-kind-icon">new_<wbr>mtls_<wbr>builder</a></li>
 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="aws_iot.awsiotmqttconnectionconfigbuilder.html#new_mtls_builder_from_path" class="tsd-kind-icon">new_<wbr>mtls_<wbr>builder_<wbr>from_<wbr>path</a></li>
+								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="aws_iot.awsiotmqttconnectionconfigbuilder.html#new_mtls_pkcs11_builder" class="tsd-kind-icon">new_<wbr>mtls_<wbr>pkcs11_<wbr>builder</a></li>
 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="aws_iot.awsiotmqttconnectionconfigbuilder.html#new_websocket_builder" class="tsd-kind-icon">new_<wbr>websocket_<wbr>builder</a></li>
 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="aws_iot.awsiotmqttconnectionconfigbuilder.html#new_with_websockets" class="tsd-kind-icon">new_<wbr>with_<wbr>websockets</a></li>
 							</ul>
@@ -126,7 +127,7 @@ <h3>build</h3>
 							</aside>
 							<div class="tsd-comment tsd-typography">
 								<div class="lead">
-									<p>Returns the configured MqttConnectionConfig.  On the first invocation of this function, the tls context is cached
+									<p>Returns the configured MqttConnectionConfig.  On the first invocation of this function, the TLS context is cached
 									and re-used on all subsequent calls to build().</p>
 								</div>
 							</div>
@@ -624,6 +625,35 @@ <h4 class="tsd-returns-title">Returns <a href="aws_iot.awsiotmqttconnectionconfi
 						</li>
 					</ul>
 				</section>
+				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
+					<a name="new_mtls_pkcs11_builder" class="tsd-anchor"></a>
+					<h3><span class="tsd-flag ts-flagStatic">Static</span> new_<wbr>mtls_<wbr>pkcs11_<wbr>builder</h3>
+					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
+						<li class="tsd-signature tsd-kind-icon">new_<wbr>mtls_<wbr>pkcs11_<wbr>builder<span class="tsd-signature-symbol">(</span>pkcs11_options<span class="tsd-signature-symbol">: </span><a href="io.tlscontextoptions.html#pkcs11options" class="tsd-signature-type">Pkcs11Options</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="aws_iot.awsiotmqttconnectionconfigbuilder.html" class="tsd-signature-type">AwsIotMqttConnectionConfigBuilder</a></li>
+					</ul>
+					<ul class="tsd-descriptions">
+						<li class="tsd-description">
+							<aside class="tsd-sources">
+							</aside>
+							<div class="tsd-comment tsd-typography">
+								<div class="lead">
+									<p>Create a new builder with mTLS using a PKCS#11 library for private key operations.</p>
+								</div>
+								<p>NOTE: This configuration only works on Unix devices.</p>
+							</div>
+							<h4 class="tsd-parameters-title">Parameters</h4>
+							<ul class="tsd-parameters">
+								<li>
+									<h5>pkcs11_options: <a href="io.tlscontextoptions.html#pkcs11options" class="tsd-signature-type">Pkcs11Options</a></h5>
+									<div class="tsd-comment tsd-typography">
+										<p>PKCS#11 options.</p>
+									</div>
+								</li>
+							</ul>
+							<h4 class="tsd-returns-title">Returns <a href="aws_iot.awsiotmqttconnectionconfigbuilder.html" class="tsd-signature-type">AwsIotMqttConnectionConfigBuilder</a></h4>
+						</li>
+					</ul>
+				</section>
 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
 					<a name="new_websocket_builder" class="tsd-anchor"></a>
 					<h3><span class="tsd-flag ts-flagStatic">Static</span> new_<wbr>websocket_<wbr>builder</h3>
@@ -761,6 +791,9 @@ <h4 class="tsd-returns-title">Returns <a href="aws_iot.awsiotmqttconnectionconfi
 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
 								<a href="aws_iot.awsiotmqttconnectionconfigbuilder.html#new_mtls_builder_from_path" class="tsd-kind-icon">new_<wbr>mtls_<wbr>builder_<wbr>from_<wbr>path</a>
 							</li>
+							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
+								<a href="aws_iot.awsiotmqttconnectionconfigbuilder.html#new_mtls_pkcs11_builder" class="tsd-kind-icon">new_<wbr>mtls_<wbr>pkcs11_<wbr>builder</a>
+							</li>
 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
 								<a href="aws_iot.awsiotmqttconnectionconfigbuilder.html#new_websocket_builder" class="tsd-kind-icon">new_<wbr>websocket_<wbr>builder</a>
 							</li>

docs/classes/aws_iot.awsiotmqttconnectionconfigbuilder.html

@@ -95,6 +95,7 @@ <h3>Constructors</h3>
 							<h3>Properties</h3>
 							<ul class="tsd-index-list">
 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="aws_iot_device_sdk.discoveryclient.html#bootstrap" class="tsd-kind-icon">bootstrap</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-class"><a href="aws_iot_device_sdk.discoveryclient.html#gg_server_name" class="tsd-kind-icon">gg_<wbr>server_<wbr>name</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="aws_iot_device_sdk.discoveryclient.html#region" class="tsd-kind-icon">region</a></li>
 							</ul>
 						</section>
@@ -113,7 +114,7 @@ <h2>Constructors</h2>
 					<a name="constructor" class="tsd-anchor"></a>
 					<h3>constructor</h3>
 					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
-						<li class="tsd-signature tsd-kind-icon">new <wbr>Discovery<wbr>Client<span class="tsd-signature-symbol">(</span>bootstrap<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClientBootstrap</span>, socket_options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SocketOptions</span>, tls_ctx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClientTlsContext</span>, region<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="aws_iot_device_sdk.discoveryclient.html" class="tsd-signature-type">DiscoveryClient</a></li>
+						<li class="tsd-signature tsd-kind-icon">new <wbr>Discovery<wbr>Client<span class="tsd-signature-symbol">(</span>bootstrap<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClientBootstrap</span>, socket_options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SocketOptions</span>, tls_ctx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClientTlsContext</span>, region<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, gg_server_name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="aws_iot_device_sdk.discoveryclient.html" class="tsd-signature-type">DiscoveryClient</a></li>
 					</ul>
 					<ul class="tsd-descriptions">
 						<li class="tsd-description">
@@ -151,7 +152,15 @@ <h5>tls_ctx: <span class="tsd-signature-type">ClientTlsContext</span></h5>
 									<h5>region: <span class="tsd-signature-type">string</span></h5>
 									<div class="tsd-comment tsd-typography">
 										<div class="lead">
-											<p>Region to send Greengrass discovery requests to</p>
+											<p>Region to send Greengrass discovery requests to (ignored if gg_server_name is set)</p>
+										</div>
+									</div>
+								</li>
+								<li>
+									<h5><span class="tsd-flag ts-flagDefault value">Default value</span> gg_server_name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;&quot;</span></h5>
+									<div class="tsd-comment tsd-typography">
+										<div class="lead">
+											<p>Optional name of greengrass endpoint</p>
 										</div>
 									</div>
 								</li>
@@ -175,6 +184,18 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> bootstrap</h3>
 						</div>
 					</div>
 				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
+					<a name="gg_server_name" class="tsd-anchor"></a>
+					<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> gg_<wbr>server_<wbr>name</h3>
+					<div class="tsd-signature tsd-kind-icon">gg_<wbr>server_<wbr>name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
+					<aside class="tsd-sources">
+					</aside>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>Optional name of greengrass endpoint</p>
+						</div>
+					</div>
+				</section>
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
 					<a name="region" class="tsd-anchor"></a>
 					<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> region</h3>
@@ -183,7 +204,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> region</h3>
 					</aside>
 					<div class="tsd-comment tsd-typography">
 						<div class="lead">
-							<p>Region to send Greengrass discovery requests to</p>
+							<p>Region to send Greengrass discovery requests to (ignored if gg_server_name is set)</p>
 						</div>
 					</div>
 				</section>
@@ -266,6 +287,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
 							<li class=" tsd-kind-property tsd-parent-kind-class">
 								<a href="aws_iot_device_sdk.discoveryclient.html#bootstrap" class="tsd-kind-icon">bootstrap</a>
 							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-class">
+								<a href="aws_iot_device_sdk.discoveryclient.html#gg_server_name" class="tsd-kind-icon">gg_<wbr>server_<wbr>name</a>
+							</li>
 							<li class=" tsd-kind-property tsd-parent-kind-class">
 								<a href="aws_iot_device_sdk.discoveryclient.html#region" class="tsd-kind-icon">region</a>
 							</li>

docs/classes/aws_iot_device_sdk.discoveryclient.html

@@ -184,6 +184,9 @@ <h4 class="tsd-returns-title">Returns <a href="io.clientbootstrap.html" class="t
 					<li class=" tsd-kind-class tsd-parent-kind-module">
 						<a href="io.inputstream.html" class="tsd-kind-icon">Input<wbr>Stream</a>
 					</li>
+					<li class=" tsd-kind-class tsd-parent-kind-module">
+						<a href="io.pkcs11lib.html" class="tsd-kind-icon">Pkcs11<wbr>Lib</a>
+					</li>
 					<li class=" tsd-kind-class tsd-parent-kind-module">
 						<a href="io.servertlscontext.html" class="tsd-kind-icon">Server<wbr>Tls<wbr>Context</a>
 					</li>

docs/classes/io.clientbootstrap.html

@@ -190,6 +190,9 @@ <h4 class="tsd-returns-title">Returns <a href="io.clienttlscontext.html" class="
 					<li class=" tsd-kind-class tsd-parent-kind-module">
 						<a href="io.inputstream.html" class="tsd-kind-icon">Input<wbr>Stream</a>
 					</li>
+					<li class=" tsd-kind-class tsd-parent-kind-module">
+						<a href="io.pkcs11lib.html" class="tsd-kind-icon">Pkcs11<wbr>Lib</a>
+					</li>
 					<li class=" tsd-kind-class tsd-parent-kind-module">
 						<a href="io.servertlscontext.html" class="tsd-kind-icon">Server<wbr>Tls<wbr>Context</a>
 					</li>

docs/classes/io.clienttlscontext.html

@@ -189,6 +189,9 @@ <h4 class="tsd-returns-title">Returns <a href="io.inputstream.html" class="tsd-s
 					</li>
 				</ul>
 				<ul class="after-current">
+					<li class=" tsd-kind-class tsd-parent-kind-module">
+						<a href="io.pkcs11lib.html" class="tsd-kind-icon">Pkcs11<wbr>Lib</a>
+					</li>
 					<li class=" tsd-kind-class tsd-parent-kind-module">
 						<a href="io.servertlscontext.html" class="tsd-kind-icon">Server<wbr>Tls<wbr>Context</a>
 					</li>