Skip to content

Commit

Permalink
Regen docs (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
christophd authored Oct 2, 2024
1 parent 865adda commit bcb7944
Show file tree
Hide file tree
Showing 6 changed files with 306 additions and 2 deletions.
2 changes: 1 addition & 1 deletion aws-s3-sink/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
</parent>

<artifactId>kn-connector-aws-s3-sink</artifactId>
<name>Knative Connectors :: aws-s3 Sink</name>
<name>Knative Connectors :: AWS S3 Sink</name>

<dependencies>
<dependency>
Expand Down
70 changes: 70 additions & 0 deletions aws-s3-sink/properties.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,74 @@
|===
|Property |Required |EnvVar |Description

|bucketNameOrArn
|yes
|CAMEL_KAMELET_AWS_S3_SINK_BUCKETNAMEORARN=<the_bucketNameOrArn>
|The S3 Bucket name or Amazon Resource Name (ARN).

|accessKey
|no
|CAMEL_KAMELET_AWS_S3_SINK_ACCESSKEY=<the_accessKey>
|The access key obtained from AWS.

|secretKey
|no
|CAMEL_KAMELET_AWS_S3_SINK_SECRETKEY=<the_secretKey>
|The secret key obtained from AWS.

|region
|yes
|CAMEL_KAMELET_AWS_S3_SINK_REGION=<the_region>
|The AWS region to access.

|autoCreateBucket
|no
|CAMEL_KAMELET_AWS_S3_SINK_AUTOCREATEBUCKET=false
|Specifies to automatically create the S3 bucket.

|useDefaultCredentialsProvider
|no
|CAMEL_KAMELET_AWS_S3_SINK_USEDEFAULTCREDENTIALSPROVIDER=false
|If true, the S3 client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key).

|useProfileCredentialsProvider
|no
|CAMEL_KAMELET_AWS_S3_SINK_USEPROFILECREDENTIALSPROVIDER=false
|Set whether the S3 client should expect to load credentials through a profile credentials provider.

|useSessionCredentials
|no
|CAMEL_KAMELET_AWS_S3_SINK_USESESSIONCREDENTIALS=false
|Set whether the S3 client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in S3.

|profileCredentialsName
|no
|CAMEL_KAMELET_AWS_S3_SINK_PROFILECREDENTIALSNAME=<the_profileCredentialsName>
|If using a profile credentials provider this parameter will set the profile name.

|sessionToken
|no
|CAMEL_KAMELET_AWS_S3_SINK_SESSIONTOKEN=<the_sessionToken>
|Amazon AWS Session Token used when the user needs to assume a IAM role.

|uriEndpointOverride
|no
|CAMEL_KAMELET_AWS_S3_SINK_URIENDPOINTOVERRIDE=<the_uriEndpointOverride>
|The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option.

|overrideEndpoint
|no
|CAMEL_KAMELET_AWS_S3_SINK_OVERRIDEENDPOINT=false
|Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option.

|forcePathStyle
|no
|CAMEL_KAMELET_AWS_S3_SINK_FORCEPATHSTYLE=false
|Forces path style when accessing AWS S3 buckets.

|keyName
|no
|CAMEL_KAMELET_AWS_S3_SINK_KEYNAME=<the_keyName>
|The key name for saving an element in the bucket.

|===
81 changes: 81 additions & 0 deletions aws-s3-sink/properties.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
spec:
type: object
properties:
aws:
type: object
properties:
s3:
type: object
properties:
bucketNameOrArn:
type: string
title: Bucket Name
description: The S3 Bucket name or Amazon Resource Name (ARN).
accessKey:
type: string
title: Access Key
description: The access key obtained from AWS.
secretKey:
type: string
title: Secret Key
description: The secret key obtained from AWS.
region:
type: string
title: AWS Region
description: The AWS region to access.
autoCreateBucket:
type: boolean
title: Autocreate Bucket
description: Specifies to automatically create the S3 bucket.
default: false
useDefaultCredentialsProvider:
type: boolean
title: Default Credentials Provider
description: If true, the S3 client loads credentials through a default
credentials provider. If false, it uses the basic authentication method
(access key and secret key).
default: false
useProfileCredentialsProvider:
type: boolean
title: Profile Credentials Provider
description: Set whether the S3 client should expect to load credentials
through a profile credentials provider.
default: false
useSessionCredentials:
type: boolean
title: Session Credentials
description: Set whether the S3 client should expect to use Session
Credentials. This is useful in situation in which the user needs to
assume a IAM role for doing operations in S3.
default: false
profileCredentialsName:
type: string
title: Profile Credentials Name
description: If using a profile credentials provider this parameter
will set the profile name.
sessionToken:
type: string
title: Session Token
description: Amazon AWS Session Token used when the user needs to assume
a IAM role.
uriEndpointOverride:
type: string
title: Overwrite Endpoint URI
description: The overriding endpoint URI. To use this option, you must
also select the `overrideEndpoint` option.
overrideEndpoint:
type: boolean
title: Endpoint Overwrite
description: Select this option to override the endpoint URI. To use
this option, you must also provide a URI for the `uriEndpointOverride`
option.
default: false
forcePathStyle:
type: boolean
title: Force Path Style
description: Forces path style when accessing AWS S3 buckets.
default: false
keyName:
type: string
title: Key Name
description: The key name for saving an element in the bucket.
2 changes: 1 addition & 1 deletion aws-sqs-sink/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
</parent>

<artifactId>kn-connector-aws-sqs-sink</artifactId>
<name>Knative Connectors :: aws-sqs Sink</name>
<name>Knative Connectors :: AWS SQS Sink</name>

<dependencies>
<dependency>
Expand Down
70 changes: 70 additions & 0 deletions aws-sqs-sink/properties.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,74 @@
|===
|Property |Required |EnvVar |Description

|queueNameOrArn
|yes
|CAMEL_KAMELET_AWS_SQS_SINK_QUEUENAMEORARN=<the_queueNameOrArn>
|The SQS Queue name or or Amazon Resource Name (ARN).

|accessKey
|no
|CAMEL_KAMELET_AWS_SQS_SINK_ACCESSKEY=<the_accessKey>
|The access key obtained from AWS.

|secretKey
|no
|CAMEL_KAMELET_AWS_SQS_SINK_SECRETKEY=<the_secretKey>
|The secret key obtained from AWS.

|region
|yes
|CAMEL_KAMELET_AWS_SQS_SINK_REGION=<the_region>
|The AWS region to access.

|autoCreateQueue
|no
|CAMEL_KAMELET_AWS_SQS_SINK_AUTOCREATEQUEUE=false
|Automatically create the SQS queue.

|amazonAWSHost
|no
|CAMEL_KAMELET_AWS_SQS_SINK_AMAZONAWSHOST=amazonaws.com
|The hostname of the Amazon AWS cloud.

|protocol
|no
|CAMEL_KAMELET_AWS_SQS_SINK_PROTOCOL=https
|The underlying protocol used to communicate with SQS.

|useDefaultCredentialsProvider
|no
|CAMEL_KAMELET_AWS_SQS_SINK_USEDEFAULTCREDENTIALSPROVIDER=false
|If true, the SQS client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key).

|useProfileCredentialsProvider
|no
|CAMEL_KAMELET_AWS_SQS_SINK_USEPROFILECREDENTIALSPROVIDER=false
|Set whether the SQS client should expect to load credentials through a profile credentials provider.

|useSessionCredentials
|no
|CAMEL_KAMELET_AWS_SQS_SINK_USESESSIONCREDENTIALS=false
|Set whether the SQS client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in SQS.

|profileCredentialsName
|no
|CAMEL_KAMELET_AWS_SQS_SINK_PROFILECREDENTIALSNAME=<the_profileCredentialsName>
|If using a profile credentials provider this parameter will set the profile name.

|sessionToken
|no
|CAMEL_KAMELET_AWS_SQS_SINK_SESSIONTOKEN=<the_sessionToken>
|Amazon AWS Session Token used when the user needs to assume a IAM role.

|uriEndpointOverride
|no
|CAMEL_KAMELET_AWS_SQS_SINK_URIENDPOINTOVERRIDE=<the_uriEndpointOverride>
|The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option.

|overrideEndpoint
|no
|CAMEL_KAMELET_AWS_SQS_SINK_OVERRIDEENDPOINT=false
|Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option.

|===
83 changes: 83 additions & 0 deletions aws-sqs-sink/properties.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
spec:
type: object
properties:
aws:
type: object
properties:
sqs:
type: object
properties:
queueNameOrArn:
type: string
title: Queue Name
description: The SQS Queue name or or Amazon Resource Name (ARN).
accessKey:
type: string
title: Access Key
description: The access key obtained from AWS.
secretKey:
type: string
title: Secret Key
description: The secret key obtained from AWS.
region:
type: string
title: AWS Region
description: The AWS region to access.
autoCreateQueue:
type: boolean
title: Autocreate Queue
description: Automatically create the SQS queue.
default: false
amazonAWSHost:
type: string
title: AWS Host
description: The hostname of the Amazon AWS cloud.
default: amazonaws.com
protocol:
type: string
title: Protocol
description: The underlying protocol used to communicate with SQS.
default: https
example: http or https
useDefaultCredentialsProvider:
type: boolean
title: Default Credentials Provider
description: If true, the SQS client loads credentials through a default
credentials provider. If false, it uses the basic authentication method
(access key and secret key).
default: false
useProfileCredentialsProvider:
type: boolean
title: Profile Credentials Provider
description: Set whether the SQS client should expect to load credentials
through a profile credentials provider.
default: false
useSessionCredentials:
type: boolean
title: Session Credentials
description: Set whether the SQS client should expect to use Session
Credentials. This is useful in situation in which the user needs to
assume a IAM role for doing operations in SQS.
default: false
profileCredentialsName:
type: string
title: Profile Credentials Name
description: If using a profile credentials provider this parameter
will set the profile name.
sessionToken:
type: string
title: Session Token
description: Amazon AWS Session Token used when the user needs to assume
a IAM role.
uriEndpointOverride:
type: string
title: Overwrite Endpoint URI
description: The overriding endpoint URI. To use this option, you must
also select the `overrideEndpoint` option.
overrideEndpoint:
type: boolean
title: Endpoint Overwrite
description: Select this option to override the endpoint URI. To use
this option, you must also provide a URI for the `uriEndpointOverride`
option.
default: false

0 comments on commit bcb7944

Please sign in to comment.