Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebsocketConfig

Websocket-specific mqtt connection configuration options

Hierarchy

  • WebsocketConfig

Index

Properties

Optional create_signing_config

create_signing_config: undefined | (() => AwsSigningConfig)

(Optional) factory function to create the configuration used to sign the websocket handshake. Leave null to use the default settings.

credentials_provider

credentials_provider: AwsCredentialsProvider

Sources the AWS Credentials used to sign the websocket connection handshake

Optional proxy_options

proxy_options: HttpProxyOptions

(Optional) http proxy configuration

region

region: string

AWS region the websocket connection is being established in. Must match the region embedded in the endpoint.

Optional service

service: undefined | string

(Optional) override for the service name used in signing the websocket handshake. Leave null to use the default (iotdevicegateway)

Optional tls_ctx_options

tls_ctx_options: io.TlsContextOptions

(Optional) tls configuration to use when establishing the connection

Generated using TypeDoc