Interface SigV4SignerOptions

Options for constructing a Signer that uses the AWS Signature Version 4 signing process.

interface SigV4SignerOptions {
    credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
    region?: string;
    service: string;
}

Properties

The credentials to use when signing the request, either as a static value or as a provider that resolves them.

credentials read from the standard Lambda environment variables

region?: string

The AWS region to use when signing the request.

process.env.AWS_REGION

service: string

The service name to use when signing the request, e.g. execute-api, lambda, or appsync.

This value cannot be reliably derived at runtime (custom domains and CloudFront hide the underlying service), so it is required.