Update wiki Home page for aws2-cw

gitea_admin 2026-03-11 14:35:23 +00:00
parent 1e28a970c7
commit d884423ca0

55
Home.md

@ -1,21 +1,48 @@
# Deploy the Project on CamelX Platform
# AWS CloudWatch
Deploy on CamelX Platform in three steps
Sending metrics to AWS CloudWatch.
## 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 |
|----------|-------|
| Scheme | `aws2-cw` |
| Support Level | Stable |
| Labels | cloud,monitoring |
| Version | 4.10.2 |
## Step 2: Deploy
Click on **"Deploy"**
## Maven Dependency
- **Version:** Select the desired release
- **Environment:** Choose `Development`, `Staging`, or `Production`
- **Configuration:** Select the configuration source
- **Resources:** Set CPU and Memory
```xml
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-aws2-cw</artifactId>
<version>4.10.2</version>
</dependency>
```
## Step 3: Expose
Enable **"Expose"**
## Endpoint Properties
Choose an **API Gateway** (Internal, Public, etc.)
| Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `namespace` | string | ✓ | | The metric namespace |
| `name` | string | | | The metric name |
| `overrideEndpoint` | boolean | | `false` | Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option |
| `region` | string | | | The region in which CW 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() |
| `timestamp` | object | | | The metric timestamp |
| `unit` | string | | | The metric unit |
| `uriEndpointOverride` | string | | | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option |
| `value` | number | | | The metric value |
| `lazyStartProducer` | boolean | | `false` | 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. |
| `amazonCwClient` | object | | | To use the AmazonCloudWatch as the client |
| `proxyHost` | string | | | To define a proxy host when instantiating the CW client |
| `proxyPort` | integer | | | To define a proxy port when instantiating the CW client |
| `proxyProtocol` | object | | `HTTPS` | To define a proxy protocol when instantiating the CW client |
| `accessKey` | string | | | Amazon AWS Access Key |
| `profileCredentialsName` | string | | | If using a profile credentials provider, this parameter will set the profile name |
| `secretKey` | string | | | Amazon AWS Secret Key |
| `sessionToken` | string | | | Amazon AWS Session Token used when the user needs to assume an IAM role |
| `trustAllCertificates` | boolean | | `false` | If we want to trust all certificates in case of overriding the endpoint |
| `useDefaultCredentialsProvider` | boolean | | `false` | Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. |
| `useProfileCredentialsProvider` | boolean | | `false` | Set whether the Cloudwatch client should expect to load credentials through a profile credentials provider. |
| `useSessionCredentials` | boolean | | `false` | Set whether the CloudWatch 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 CloudWatch. |