Interface WebsocketConfig

Websocket-specific mqtt connection configuration options

Hierarchy

  • WebsocketOptionsBase
    • WebsocketConfig

Properties

credentials_provider proxy_options? region tls_ctx_options? create_signing_config? service?

Properties

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 tls_ctx_options

tls_ctx_options?: TlsContextOptions

(Optional) TLS configuration to use when establishing the connection

Optional create_signing_config

create_signing_config?: (() => AwsSigningConfigBase)

Type declaration

Optional service

service?: string

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc