PollyTTSConfig

Defined in: src/providers/tts/polly/PollyTTS.ts:98

Configuration for the PollyTTS provider.

Remarks

Provide either credentials + region (for direct AWS access) or proxyUrl (for a server-side proxy that SigV4-signs upstream requests). At least one must be set. If both are provided, proxyUrl takes precedence and no credentials are used client-side.

For browsers, prefer proxyUrl, or pass an async credentials factory that fetches temporary credentials (STS/Cognito) from your backend — never embed long-lived AWS keys in client code.

Example

// Server-side with static credentials
const config: PollyTTSConfig = {
  credentials: {
    accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
    secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!,
  },
  region: 'us-east-1',
  voiceId: 'Joanna',
  engine: 'neural',
};

// Browser with temporary credentials from your backend
const browserConfig: PollyTTSConfig = {
  credentials: async () => (await fetch('/api/aws-credentials')).json(),
  region: 'us-east-1',
  voiceId: 'Joanna',
};

// Via proxy server (recommended for production browsers)
const proxyConfig: PollyTTSConfig = {
  proxyUrl: 'http://localhost:3001/api/proxy/polly',
  voiceId: 'Joanna',
};

See

• PollyEngine - Available engine options.
• PollyOutputFormat - Available audio format options.

Extends

• TTSProviderConfig

Properties