Interface ESPRMNeoBaseConfig

SDK configuration for ESPRMNeoBase.configure. Supplies Rainmaker API base URL, Cognito/IoT identifiers, and optional adapters.

Put the API Gateway stage in baseUrl when using the default execute-api host (e.g. https://xxx.execute-api.region.amazonaws.com/prod). Custom domains typically need no stage segment.

interface ESPRMNeoBaseConfig {
    awsRegion: string;
    baseUrl: string;
    customStorageAdapter?: ESPStorageAdapter;
    iotEndpoint: string;
    localControlAdapter?: ESPLocalControlAdapterInterface;
    localDiscoveryAdapter?: ESPLocalDiscoveryAdapterInterface;
    mqttAdapter?: MQTTTransport;
    provisionAdapter?: ESPProvisionAdapterInterface;
    userApiBase: string;
}

Properties

awsRegion baseUrl customStorageAdapter? iotEndpoint localControlAdapter? localDiscoveryAdapter? mqttAdapter? provisionAdapter? userApiBase

Properties

awsRegion

awsRegion: string

baseUrl

baseUrl: string

Full main API base, including stage if any. e.g. "https://xxx.execute-api.us-east-1.amazonaws.com/prod" or custom domain "https://api.example.com"

OptionalcustomStorageAdapter

customStorageAdapter?: ESPStorageAdapter

iotEndpoint

iotEndpoint: string

OptionallocalControlAdapter

localControlAdapter?: ESPLocalControlAdapterInterface

OptionallocalDiscoveryAdapter

localDiscoveryAdapter?: ESPLocalDiscoveryAdapterInterface

OptionalmqttAdapter

mqttAdapter?: MQTTTransport

OptionalprovisionAdapter

provisionAdapter?: ESPProvisionAdapterInterface

userApiBase

userApiBase: string

Full User/auth API base, including stage if any. e.g. "https://xxx.execute-api.us-east-1.amazonaws.com/prod" or custom domain "https://api.example.com"

Settings

Member Visibility

On This Page

Properties