CommandableLambdaClient

Abstract client that calls commandable AWS Lambda Functions.

Extends: LambdaClient

Description

Commandable services are generated automatically for ICommandable. Each command is exposed as an action determined by the “cmd” parameter.

Configuration parameters

  • connections:
    • discovery_key: (optional) key to retrieve the connection from IDiscovery
    • region: (optional) AWS region
  • credentials:
    • store_key: (optional) key to retrieve the credentials from ICredentialStore
    • access_id: AWS access/client id
    • access_key: AWS access/client key
  • options:
    • connect_timeout: (optional) connection timeout in milliseconds (default: 10 sec)

References

  • *:logger:*:*:1.0 - (optional) ILogger components to pass log messages.
  • *:counters:*:*:1.0 - (optional) ICounters components to pass collected measurements.
  • *:discovery:*:*:1.0 - (optional) IDiscovery services to resolve connection.
  • *:credential-store:*:*:1.0 - (optional) Credential stores to resolve credentials.

Constructors

Creates a new instance of this client.

public constructor(name: string)

  • name: string - a service name.

Instance methods

callCommand

Calls a remote action in AWS Lambda function. The name of the action is added as “cmd” parameter to the action parameters.

public callCommand(cmd: string, correlationId: string, params: any): Promise<any>

  • cmd: string - action name
  • correlationId: string - (optional) transaction id to trace execution through call chain.
  • params: any - command parameters.
  • returns: Promise<any> - action result.

Examples

class MyLambdaClient extends CommandableLambdaClient implements IMyClient {
    ...
 
    public async getData(correlationId: string, id: string): Promise<any> {
        return this.callCommand("get_data", correlationId, { id: id });
    }
    ...
}
let client = new MyLambdaClient();
client.configure(ConfigParams.fromTuples(
    "connection.region", "us-east-1",
    "connection.access_id", "XXXXXXXXXXX",
    "connection.access_key", "XXXXXXXXXXX",
    "connection.arn", "YYYYYYYYYYYYY"
));
     
const result = await client.getData("123", "1");
...

See also