AWS Polly

Synthesize speech using AWS Polly and AWS SDK version 2.x.

What’s inside

AWS Polly component, URI syntax: aws2-polly:label

Please refer to the above links for usage and configuration details.

Maven coordinates

<dependency>
    <groupId>org.apache.camel.springboot</groupId>
    <artifactId>camel-aws2-polly-starter</artifactId>
</dependency>

Spring Boot Auto-Configuration

The starter supports 36 options, which are listed below.

Name	Description	Default	Type
camel.component.aws2-polly.access-key	Amazon AWS Access Key		String
camel.component.aws2-polly.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.aws2-polly.configuration	Component configuration. The option is a org.apache.camel.component.aws2.polly.Polly2Configuration type.		Polly2Configuration
camel.component.aws2-polly.enabled	Whether to enable auto configuration of the aws2-polly component. This is enabled by default.		Boolean
camel.component.aws2-polly.engine	The engine to use for synthesis (standard, neural, long-form, generative)		Engine
camel.component.aws2-polly.health-check-consumer-enabled	Used for enabling or disabling all consumer based health checks from this component	true	Boolean
camel.component.aws2-polly.health-check-producer-enabled	Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true.	true	Boolean
camel.component.aws2-polly.language-code	The language code for the synthesis		String
camel.component.aws2-polly.lazy-start-producer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean
camel.component.aws2-polly.lexicon-content	The content of the lexicon in PLS format for putLexicon operation		String
camel.component.aws2-polly.lexicon-name	The name of the lexicon to use for getLexicon, putLexicon, or deleteLexicon operations		String
camel.component.aws2-polly.lexicon-names	Lexicon names to apply during synthesis		String
camel.component.aws2-polly.operation	The operation to perform	synthesizespeech	Polly2Operations
camel.component.aws2-polly.output-format	The audio output format	mp3	OutputFormat
camel.component.aws2-polly.override-endpoint	Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option	false	Boolean
camel.component.aws2-polly.pojo-request	If we want to use a POJO request as body or not	false	Boolean
camel.component.aws2-polly.polly-client	To use an existing configured AWS Polly client. The option is a software.amazon.awssdk.services.polly.PollyClient type.		PollyClient
camel.component.aws2-polly.profile-credentials-name	If using a profile credentials provider, this parameter will set the profile name		String
camel.component.aws2-polly.proxy-host	To define a proxy host when instantiating the Polly client		String
camel.component.aws2-polly.proxy-port	To define a proxy port when instantiating the Polly client		Integer
camel.component.aws2-polly.proxy-protocol	To define a proxy protocol when instantiating the Polly client	https	Protocol
camel.component.aws2-polly.region	The region in which the Polly client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()		String
camel.component.aws2-polly.s3-bucket	The S3 bucket name for startSpeechSynthesisTask operation output		String
camel.component.aws2-polly.s3-key-prefix	The S3 key prefix for startSpeechSynthesisTask operation output		String
camel.component.aws2-polly.sample-rate	The sample rate in Hz for the audio output		String
camel.component.aws2-polly.secret-key	Amazon AWS Secret Key		String
camel.component.aws2-polly.session-token	Amazon AWS Session Token used when the user needs to assume an IAM role		String
camel.component.aws2-polly.sns-topic-arn	The SNS topic ARN for startSpeechSynthesisTask notifications		String
camel.component.aws2-polly.task-id	The task ID for getSpeechSynthesisTask operation		String
camel.component.aws2-polly.text-type	The type of text input (text or ssml)	text	TextType
camel.component.aws2-polly.trust-all-certificates	If we want to trust all certificates in case of overriding the endpoint	false	Boolean
camel.component.aws2-polly.uri-endpoint-override	Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option		String
camel.component.aws2-polly.use-default-credentials-provider	Set whether the Polly client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.	false	Boolean
camel.component.aws2-polly.use-profile-credentials-provider	Set whether the Polly client should expect to load credentials through a profile credentials provider.	false	Boolean
camel.component.aws2-polly.use-session-credentials	Set whether the Polly client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Polly.	false	Boolean
camel.component.aws2-polly.voice-id	The voice ID to use for synthesis		VoiceId

Name

Description

Default

Type

camel.component.aws2-polly.access-key

Amazon AWS Access Key

String

camel.component.aws2-polly.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.aws2-polly.configuration

Component configuration. The option is a org.apache.camel.component.aws2.polly.Polly2Configuration type.

Polly2Configuration

camel.component.aws2-polly.enabled

Whether to enable auto configuration of the aws2-polly component. This is enabled by default.

Boolean

camel.component.aws2-polly.engine

The engine to use for synthesis (standard, neural, long-form, generative)

Engine

camel.component.aws2-polly.health-check-consumer-enabled

Used for enabling or disabling all consumer based health checks from this component

true

Boolean

camel.component.aws2-polly.health-check-producer-enabled

Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true.

true

Boolean

camel.component.aws2-polly.language-code

The language code for the synthesis

String

camel.component.aws2-polly.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.aws2-polly.lexicon-content

The content of the lexicon in PLS format for putLexicon operation

String

camel.component.aws2-polly.lexicon-name

The name of the lexicon to use for getLexicon, putLexicon, or deleteLexicon operations

String

camel.component.aws2-polly.lexicon-names

Lexicon names to apply during synthesis

String

camel.component.aws2-polly.operation

The operation to perform

synthesizespeech

Polly2Operations

camel.component.aws2-polly.output-format

The audio output format

mp3

OutputFormat

camel.component.aws2-polly.override-endpoint

Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option

false

Boolean

camel.component.aws2-polly.pojo-request

If we want to use a POJO request as body or not

false

Boolean

camel.component.aws2-polly.polly-client

To use an existing configured AWS Polly client. The option is a software.amazon.awssdk.services.polly.PollyClient type.

PollyClient

camel.component.aws2-polly.profile-credentials-name

If using a profile credentials provider, this parameter will set the profile name

String

camel.component.aws2-polly.proxy-host

To define a proxy host when instantiating the Polly client

String

camel.component.aws2-polly.proxy-port

To define a proxy port when instantiating the Polly client

Integer

camel.component.aws2-polly.proxy-protocol

To define a proxy protocol when instantiating the Polly client

https

Protocol

camel.component.aws2-polly.region

The region in which the Polly client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

String

camel.component.aws2-polly.s3-bucket

The S3 bucket name for startSpeechSynthesisTask operation output

String

camel.component.aws2-polly.s3-key-prefix

The S3 key prefix for startSpeechSynthesisTask operation output

String

camel.component.aws2-polly.sample-rate

The sample rate in Hz for the audio output

String

camel.component.aws2-polly.secret-key

Amazon AWS Secret Key

String

camel.component.aws2-polly.session-token

Amazon AWS Session Token used when the user needs to assume an IAM role

String

camel.component.aws2-polly.sns-topic-arn

The SNS topic ARN for startSpeechSynthesisTask notifications

String

camel.component.aws2-polly.task-id

The task ID for getSpeechSynthesisTask operation

String

camel.component.aws2-polly.text-type

The type of text input (text or ssml)

text

TextType

camel.component.aws2-polly.trust-all-certificates

If we want to trust all certificates in case of overriding the endpoint

false

Boolean

camel.component.aws2-polly.uri-endpoint-override

Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option

String

camel.component.aws2-polly.use-default-credentials-provider

Set whether the Polly client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.

false

Boolean

camel.component.aws2-polly.use-profile-credentials-provider

Set whether the Polly client should expect to load credentials through a profile credentials provider.

false

Boolean

camel.component.aws2-polly.use-session-credentials

Set whether the Polly client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Polly.

false

Boolean

camel.component.aws2-polly.voice-id

The voice ID to use for synthesis

VoiceId