This is an automated email from the ASF dual-hosted git repository.
dannycranmer pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-connector-aws.git
commit 17820d062007a4fcdf24c3b974c636f32705cd27
Author: Emre Kartoglu <kar...@amazon.co.uk>
AuthorDate: Fri Apr 21 10:38:07 2023 +0100
[FLINK-22828][Connectors/AWS] Update docs
---
docs/content.zh/docs/connectors/table/dynamodb.md | 10 ++++++++++
docs/content.zh/docs/connectors/table/firehose.md | 11 ++++++++++-
docs/content.zh/docs/connectors/table/kinesis.md | 11 +++++++++++
docs/content/docs/connectors/table/dynamodb.md | 11 +++++++++++
docs/content/docs/connectors/table/firehose.md | 11 ++++++++++-
docs/content/docs/connectors/table/kinesis.md | 11 +++++++++++
6 files changed, 63 insertions(+), 2 deletions(-)
diff --git a/docs/content.zh/docs/connectors/table/dynamodb.md
b/docs/content.zh/docs/connectors/table/dynamodb.md
index b75d6a2..128fd3b 100644
--- a/docs/content.zh/docs/connectors/table/dynamodb.md
+++ b/docs/content.zh/docs/connectors/table/dynamodb.md
@@ -186,6 +186,14 @@ Connector Options
<td>String</td>
<td>The absolute path to the web identity token file that should be used
if provider type is set to WEB_IDENTITY_TOKEN.</td>
</tr>
+ <tr>
+ <td><h5>aws.credentials.custom.class</h5></td>
+ <td>required only if credential provider is set to CUSTOM</td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The full path (in Java package notation) to the user provided
+ class to use if credential provider type is set to be CUSTOM e.g.
org.user_company.auth.CustomAwsCredentialsProvider.</td>
+ </tr>
</tbody>
<thead>
<tr>
@@ -272,6 +280,8 @@ Supported values are:
- `PROFILE` - Use an AWS credentials profile to create the AWS credentials.
- `ASSUME_ROLE` - Create AWS credentials by assuming a role. The credentials
for assuming the role must be supplied.
- `WEB_IDENTITY_TOKEN` - Create AWS credentials by assuming a role using Web
Identity Token.
+- `CUSTOM` - Provide a custom class that implements the interface
`AWSCredentialsProvider` and has a constructor
`MyCustomClass(java.util.Properties config)`. All connector properties will be
passed down to this custom
+ credential provider class via the constructor.
## Sink Partitioning
diff --git a/docs/content.zh/docs/connectors/table/firehose.md
b/docs/content.zh/docs/connectors/table/firehose.md
index 4b63799..a2bab74 100644
--- a/docs/content.zh/docs/connectors/table/firehose.md
+++ b/docs/content.zh/docs/connectors/table/firehose.md
@@ -183,7 +183,6 @@ Connector Options
<tr>
<td><h5>aws.credentials.role.stsEndpoint</h5></td>
<td>optional</td>
- <td>no</td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>The AWS endpoint for STS (derived from the AWS region setting if
not set) to use when credential provider type is set to ASSUME_ROLE.</td>
@@ -202,6 +201,14 @@ Connector Options
<td>String</td>
<td>The absolute path to the web identity token file that should be used if
provider type is set to WEB_IDENTITY_TOKEN.</td>
</tr>
+ <tr>
+ <td><h5>aws.credentials.custom.class</h5></td>
+ <td>required only if credential provider is set to CUSTOM</td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The full path (in Java package notation) to the user provided
+ class to use if credential provider type is set to be CUSTOM e.g.
org.user_company.auth.CustomAwsCredentialsProvider.</td>
+ </tr>
</tbody>
<thead>
<tr>
@@ -299,6 +306,8 @@ Supported values are:
- `PROFILE` - Use an AWS credentials profile to create the AWS credentials.
- `ASSUME_ROLE` - Create AWS credentials by assuming a role. The credentials
for assuming the role must be supplied.
- `WEB_IDENTITY_TOKEN` - Create AWS credentials by assuming a role using Web
Identity Token.
+- `CUSTOM` - Provide a custom class that implements the interface
`AWSCredentialsProvider` and has a constructor
`MyCustomClass(java.util.Properties config)`. All connector properties will be
passed down to this custom
+ credential provider class via the constructor.-
## Data Type Mapping
diff --git a/docs/content.zh/docs/connectors/table/kinesis.md
b/docs/content.zh/docs/connectors/table/kinesis.md
index fc14dff..c7df190 100644
--- a/docs/content.zh/docs/connectors/table/kinesis.md
+++ b/docs/content.zh/docs/connectors/table/kinesis.md
@@ -280,6 +280,15 @@ Connector Options
<td>String</td>
<td>The absolute path to the web identity token file that should be
used if provider type is set to WEB_IDENTITY_TOKEN.</td>
</tr>
+ <tr>
+ <td><h5>aws.credentials.custom.class</h5></td>
+ <td>required only if credential provider is set to CUSTOM</td>
+ <td>no</td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The full path (in Java package notation) to the user provided
+ class to use if credential provider type is set to be CUSTOM e.g.
org.user_company.auth.CustomAwsCredentialsProvider.</td>
+ </tr>
</tbody>
<thead>
<tr>
@@ -832,6 +841,8 @@ Supported values are:
* `PROFILE` - Use an AWS credentials profile to create the AWS credentials.
* `ASSUME_ROLE` - Create AWS credentials by assuming a role. The credentials
for assuming the role must be supplied.
* `WEB_IDENTITY_TOKEN` - Create AWS credentials by assuming a role using Web
Identity Token.
+* `CUSTOM` - Provide a custom class that implements the interface
`AWSCredentialsProvider` and has a constructor
`MyCustomClass(java.util.Properties config)`. All connector properties will be
passed down to this custom
+credential provider class via the constructor.
### Start Reading Position
diff --git a/docs/content/docs/connectors/table/dynamodb.md
b/docs/content/docs/connectors/table/dynamodb.md
index bb35b39..22e4bf8 100644
--- a/docs/content/docs/connectors/table/dynamodb.md
+++ b/docs/content/docs/connectors/table/dynamodb.md
@@ -185,6 +185,14 @@ Connector Options
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>The absolute path to the web identity token file that should be used
if provider type is set to WEB_IDENTITY_TOKEN.</td>
+ </tr>
+ <tr>
+ <td><h5>aws.credentials.custom.class</h5></td>
+ <td>required only if credential provider is set to CUSTOM</td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The full path (in Java package notation) to the user provided
+ class to use if credential provider type is set to be CUSTOM e.g.
org.user_company.auth.CustomAwsCredentialsProvider.</td>
</tr>
</tbody>
<thead>
@@ -272,6 +280,9 @@ Supported values are:
- `PROFILE` - Use an AWS credentials profile to create the AWS credentials.
- `ASSUME_ROLE` - Create AWS credentials by assuming a role. The credentials
for assuming the role must be supplied.
- `WEB_IDENTITY_TOKEN` - Create AWS credentials by assuming a role using Web
Identity Token.
+- `CUSTOM` - Provide a custom class that implements the interface
`AWSCredentialsProvider` and has a constructor
`MyCustomClass(java.util.Properties config)`. All connector properties will be
passed down to this custom
+ credential provider class via the constructor.
+
## Sink Partitioning
diff --git a/docs/content/docs/connectors/table/firehose.md
b/docs/content/docs/connectors/table/firehose.md
index 78c8f7a..1aa570b 100644
--- a/docs/content/docs/connectors/table/firehose.md
+++ b/docs/content/docs/connectors/table/firehose.md
@@ -183,7 +183,6 @@ Connector Options
<tr>
<td><h5>aws.credentials.role.stsEndpoint</h5></td>
<td>optional</td>
- <td>no</td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>The AWS endpoint for STS (derived from the AWS region setting if
not set) to use when credential provider type is set to ASSUME_ROLE.</td>
@@ -202,6 +201,14 @@ Connector Options
<td>String</td>
<td>The absolute path to the web identity token file that should be used if
provider type is set to WEB_IDENTITY_TOKEN.</td>
</tr>
+ <tr>
+ <td><h5>aws.credentials.custom.class</h5></td>
+ <td>required only if credential provider is set to CUSTOM</td>
+ <td>(none)</td>
+ <td style="word-wrap: break-word;">String</td>
+ <td>The full path (in Java package notation) to the user provided
+ class to use if credential provider type is set to be CUSTOM e.g.
org.user_company.auth.CustomAwsCredentialsProvider.</td>
+ </tr>
</tbody>
<thead>
<tr>
@@ -299,6 +306,8 @@ Supported values are:
- `PROFILE` - Use an AWS credentials profile to create the AWS credentials.
- `ASSUME_ROLE` - Create AWS credentials by assuming a role. The credentials
for assuming the role must be supplied.
- `WEB_IDENTITY_TOKEN` - Create AWS credentials by assuming a role using Web
Identity Token.
+- `CUSTOM` - Provide a custom class that implements the interface
`AWSCredentialsProvider` and has a constructor
`MyCustomClass(java.util.Properties config)`. All connector properties will be
passed down to this custom
+ credential provider class via the constructor.
## Data Type Mapping
diff --git a/docs/content/docs/connectors/table/kinesis.md
b/docs/content/docs/connectors/table/kinesis.md
index a9d7610..47a656c 100644
--- a/docs/content/docs/connectors/table/kinesis.md
+++ b/docs/content/docs/connectors/table/kinesis.md
@@ -281,6 +281,15 @@ Connector Options
<td>String</td>
<td>The absolute path to the web identity token file that should be
used if provider type is set to WEB_IDENTITY_TOKEN.</td>
</tr>
+ <tr>
+ <td><h5>aws.credentials.custom.class</h5></td>
+ <td>required only if credential provider is set to CUSTOM</td>
+ <td>no</td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The full path (in Java package notation) to the user provided
+ class to use if credential provider type is set to be CUSTOM e.g.
org.user_company.auth.CustomAwsCredentialsProvider.</td>
+ </tr>
</tbody>
<thead>
<tr>
@@ -833,6 +842,8 @@ Supported values are:
* `PROFILE` - Use an AWS credentials profile to create the AWS credentials.
* `ASSUME_ROLE` - Create AWS credentials by assuming a role. The credentials
for assuming the role must be supplied.
* `WEB_IDENTITY_TOKEN` - Create AWS credentials by assuming a role using Web
Identity Token.
+* `CUSTOM` - Provide a custom class that implements the interface
`AWSCredentialsProvider` and has a constructor
`MyCustomClass(java.util.Properties config)`. All connector properties will be
passed down to this custom
+credential provider class via the constructor.
### Start Reading Position
