PresignAwsUrlOptions
Options for presignAwsUrl.
Defined in: src/utils/aws/sigv4.ts:119
Options for presignAwsUrl.
Extends
SigV4BaseOptions
Properties
| Property | Type | Default value | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
credentials | AwsCredentials | undefined | Credentials to sign with. | SigV4BaseOptions.credentials | src/utils/aws/sigv4.ts:93 |
date? | Date | undefined | Signing time. Defaults to new Date(); injectable for deterministic tests. | SigV4BaseOptions.date | src/utils/aws/sigv4.ts:97 |
expiresIn? | number | 300 (5 minutes, AWS WebSocket maximum) | URL validity window in seconds. | - | src/utils/aws/sigv4.ts:123 |
method? | string | 'GET' | HTTP method the presigned URL authorizes. | - | src/utils/aws/sigv4.ts:121 |
payloadHash? | string | SHA-256 of the empty string, which is what AWS WebSocket presigning (Amazon Transcribe streaming) requires. Pass 'UNSIGNED-PAYLOAD' for S3-style presigning. | Hex payload hash placed in the canonical request. | - | src/utils/aws/sigv4.ts:131 |
region | string | undefined | AWS region used in the credential scope (e.g. 'us-east-1'). | SigV4BaseOptions.region | src/utils/aws/sigv4.ts:91 |
service | string | undefined | AWS service identifier used in the credential scope (e.g. 'polly', 'transcribe'). | SigV4BaseOptions.service | src/utils/aws/sigv4.ts:89 |
url | string | undefined | Full request URL including any query string. | SigV4BaseOptions.url | src/utils/aws/sigv4.ts:87 |