diff --git a/Home.md b/Home.md index 93a012c..a729ca4 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,40 @@ -# Deploy the Project on CamelX Platform +# AWS Polly Sink -Deploy on CamelX Platform in three steps +Synthesize speech from text using AWS Polly. -## Step 1: Create a release -From the project space, click on **"Create a release"** +## Metadata -The new version is automatically available in the list +| Property | Value | +|----------|-------| +| Type | sink | +| Group | AWS Polly | +| Namespace | AWS | +| Support Level | Preview | +| Provider | Apache Software Foundation | -## Step 2: Deploy -Click on **"Deploy"** +## Properties -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `voiceId` | string | | | The voice ID to use for speech synthesis (e.g., Joanna, Matthew, Amy, Brian). | +| `outputFormat` | string | | `MP3` | The audio format in which the resulting stream will be encoded. | +| `textType` | string | | `TEXT` | Specifies whether the input text is plain text or SSML. | +| `engine` | string | | | Specifies the engine (standard, neural, long-form, generative) for Amazon Polly to use when processing input text for speech synthesis. | +| `sampleRate` | string | | | The audio frequency in Hz. | +| `languageCode` | string | | | Optional language code for voice synthesis. This is only necessary if using a bilingual voice. | +| `accessKey` | string | | | The access key obtained from AWS. | +| `secretKey` | string | | | The secret key obtained from AWS. | +| `region` | string | ✓ | | The AWS region to access. | +| `useDefaultCredentialsProvider` | boolean | | `false` | If true, the Polly client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). | +| `useProfileCredentialsProvider` | boolean | | `false` | Set whether the Polly client should expect to load credentials through a profile credentials provider. | +| `useSessionCredentials` | boolean | | `false` | 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. | +| `profileCredentialsName` | string | | | If using a profile credentials provider this parameter sets the profile name. | +| `sessionToken` | string | | | Amazon AWS Session Token used when the user needs to assume an IAM role. | +| `uriEndpointOverride` | string | | | The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. | +| `overrideEndpoint` | boolean | | `false` | Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. | -## Step 3: Expose -Enable **"Expose"** +## Dependencies -Choose an **API Gateway** (Internal, Public, etc.) +- `camel:core` +- `camel:aws2-polly` +- `camel:kamelet`