Interface ClientOptions

Client Options

interface ClientOptions {
    port?: string;
    requester?: Requester;
    token?: string;
}

Properties

port?: string

Port is the Lambda Extension HTTP listener's assigned port on localhost.

The Lambda service sets a default value of "2773" in PARAMETERS_SECRETS_EXTENSION_HTTP_PORT. Lambda users can override the default by setting the Lambda Function's environment variable.

http://localhost:<port>

Default

process.env.PARAMETERS_SECRETS_EXTENSION_HTTP_PORT ?? "2773"
requester?: Requester

An object capable of making a HTTP GET Request

Default

FetchRequester

token?: string

Requests to the extension require an AWS-supplied session token. The Lambda service sets the opaque token value for running functions in the AWS_SESSION_TOKEN environment variable.

The Client sends the token in the X-Aws-Parameters-Secrets-Token header. Using this header indicates that the caller is within the Lambda environment.

Default

process.env.AWS_SESSION_TOKEN

Generated using TypeDoc