aws-crt

/** * Module for AWS IoT configuration and connection establishment * * @packageDocumentation */ import { CredentialsProvider } from "./auth"; import { SocketOptions } from "./io"; import { MqttConnectionConfig, MqttWill } from "./mqtt"; /** * Builder functions to create a {@link MqttConnectionConfig} which can then be used to create * a {@link MqttClientConnection}, configured for use with AWS IoT. * * @category IoT */ export declare class AwsIotMqttConnectionConfigBuilder { private params; private constructor(); /** * For API compatibility with the native version. Does not set up mTLS. * * @returns a new websocket connection builder object with default TLS configuration */ static new_mtls_builder(...args: any[]): AwsIotMqttConnectionConfigBuilder; /** * For API compatibility with the native version. Alias for {@link new_builder_for_websocket}. * * @returns a new websocket connection builder object with default TLS configuration */ static new_with_websockets(...args: any[]): AwsIotMqttConnectionConfigBuilder; /** * For API compatibility with the native version. Alias for {@link new_builder_for_websocket}. * * @returns a new websocket connection builder object with default TLS configuration */ static new_default_builder(): AwsIotMqttConnectionConfigBuilder; /** * Creates a new builder using MQTT over websockets (the only option in browser) * * @returns a new websocket connection builder object with default TLS configuration */ static new_builder_for_websocket(): AwsIotMqttConnectionConfigBuilder; /** * Configures the IoT endpoint for this connection * @param endpoint The IoT endpoint to connect to * * @returns this builder object */ with_endpoint(endpoint: string): this; /** * The client id to use for this connection * @param client_id The client id to use for this connection * * @returns this builder object */ with_client_id(client_id: string): this; /** * The port to connect to on the IoT endpoint * @param port The port to connect to on the IoT endpoint. Usually 8883 for MQTT, or 443 for websockets * * @returns this builder object */ with_port(port: number): this; /** * Determines whether or not the service should try to resume prior subscriptions, if it has any * @param clean_session true if the session should drop prior subscriptions when this client connects, false to resume the session * * @returns this builder object */ with_clean_session(clean_session: boolean): this; /** * Configures the connection to use MQTT over websockets. No-op in the browser. * * @returns this builder object */ with_use_websockets(): this; /** * Configures MQTT keep-alive via PING messages. Note that this is not TCP keepalive. * @param keep_alive How often in seconds to send an MQTT PING message to the service to keep the connection alive * * @returns this builder object */ with_keep_alive_seconds(keep_alive: number): this; /** * Configures the TCP socket timeout (in milliseconds) * @param timeout_ms TCP socket timeout * @deprecated in favor of socket options * * @returns this builder object */ with_timeout_ms(timeout_ms: number): this; /** * Configures the PINGREQ response timeout (in milliseconds) * @param ping_timeout PINGREQ response timeout * * @returns this builder object */ with_ping_timeout_ms(ping_timeout: number): this; /** * Configures the will message to be sent when this client disconnects * @param will The will topic, qos, and message * * @returns this builder object */ with_will(will: MqttWill): this; /** * Configures the common settings for the socket to use when opening a connection to the server * @param socket_options The socket settings * * @returns this builder object */ with_socket_options(socket_options: SocketOptions): this; /** * Allows additional headers to be sent when establishing a websocket connection. Useful for custom authentication. * @param headers Additional headers to send during websocket connect * * @returns this builder object */ with_websocket_headers(headers: { [index: string]: string; }): this; /** * Configures Static AWS credentials for this connection. * Please note that the static credential will fail when the web session expired. * @param aws_region The service region to connect to * @param aws_access_id IAM Access ID * @param aws_secret_key IAM Secret Key * @param aws_sts_token session credentials token (optional) * * @returns this builder object */ with_credentials(aws_region: string, aws_access_id: string, aws_secret_key: string, aws_sts_token?: string): this; /** * Configures credentials provider (currently support for AWS Cognito Credential Provider) for this connection * @param customer_provider credential provider used to update credential when session expired (optional) * * @returns this builder object */ with_credential_provider(customer_provider: CredentialsProvider): this; /** * Sets the custom authorizer settings. This function will modify the username, port, and TLS options. * * @param username The username to use with the custom authorizer. If an empty string is passed, it will * check to see if a username has already been set (via WithUsername function). If no * username is set then no username will be passed with the MQTT connection. * @param authorizerName The name of the custom authorizer. If an empty string is passed, then * 'x-amz-customauthorizer-name' will not be added with the MQTT connection. * @param authorizerSignature The signature of the custom authorizer. If an empty string is passed, then * 'x-amz-customauthorizer-signature' will not be added with the MQTT connection. * @param password The password to use with the custom authorizer. If null is passed, then no password will * be set. */ with_custom_authorizer(username: string, authorizer_name: string, authorizer_signature: string, password: string): this; /** * Sets username for the connection * * @param username the username that will be passed with the MQTT connection */ with_username(username: string): this; /** * Sets password for the connection * * @param password the password that will be passed with the MQTT connection */ with_password(password: string): this; /** * Configure the max reconnection period (in second). The reconnection period will * be set in range of [reconnect_min_sec,reconnect_max_sec]. * @param reconnect_max_sec max reconnection period */ with_reconnect_max_sec(max_sec: number): this; /** * Configure the min reconnection period (in second). The reconnection period will * be set in range of [reconnect_min_sec,reconnect_max_sec]. * @param reconnect_min_sec min reconnection period */ with_reconnect_min_sec(min_sec: number): this; /** * Returns the configured MqttConnectionConfig * @returns The configured MqttConnectionConfig */ build(): MqttConnectionConfig; }