Interface WebsocketConfig

Websocket-specific mqtt connection configuration options

Hierarchy

  • WebsocketOptionsBase
    • WebsocketConfig

Properties

credentials_provider: AwsCredentialsProvider

Sources the AWS Credentials used to sign the websocket connection handshake

proxy_options?: HttpProxyOptions

(Optional) http proxy configuration

region: string

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

tls_ctx_options?: TlsContextOptions

(Optional) TLS configuration to use when establishing the connection

create_signing_config?: (() => AwsSigningConfigBase)

Type declaration

service?: string

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

Generated using TypeDoc