Interface WebsocketSigv4Config

Websocket-specific MQTT5 client AWS IoT configuration options

Hierarchy

  • WebsocketSigv4Config

Properties

credentialsProvider?: AwsCredentialsProvider

Sources the AWS Credentials used to sign the websocket connection handshake. If not provided, the default credentials provider chain is used.

region?: string

AWS region the websocket connection is being established in. Must match the region embedded in the endpoint. If not provided, pattern-matching logic is used to extract the region from the endpoint. Use this option if the pattern-matching logic has not yet been updated to handle new endpoint formats.

Generated using TypeDoc