Skip to content

Commit

Permalink
Replace lambda.* prefix on credentials configs with aws.* prefix for …
Browse files Browse the repository at this point in the history
…consistency purposes
  • Loading branch information
seananthonywilliams committed Jul 16, 2019
1 parent 234e1ec commit 2d18713
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
The AWS Lambda connector plugin provides the ability to use AWS Lambda functions as a sink (out of a Kafka topic into a Lambda function).

## Supported Kafka and AWS versions
The `kafka-connect-lambda` connector has been tested with `connect-api:2.1.0` and `aws-java-sdk-lambda:1.11.587`
The `kafka-connect-lambda` connector has been tested with `connect-api:2.1.0` and `aws-java-sdk-lambda:1.11.592`

# Building
You can build the connector with Maven using the standard lifecycle goals:
Expand All @@ -21,10 +21,10 @@ A sink connector configuration has two required fields:

### AWS Assume Role Support options
The connector can assume an IAM Role. The role must include a policy that allows lambda:InvokeFunction and lambda:InvokeAsync actions:
* `lambda.credentials.provider.class=com.nordstrom.kafka.connect.auth.AWSAssumeRoleCredentialsProvider`: REQUIRED The credentials provider class.
* `lambda.credentials.provider.role.arn`: REQUIRED AWS Role ARN providing the access.
* `lambda.credentials.provider.session.name`: REQUIRED Session name
* `lambda.credentials.provider.external.id`: OPTIONAL (but recommended) External identifier used by the `kafka-connect-lambda` when assuming the role.
* `aws.credentials.provider.class=com.nordstrom.kafka.connect.auth.AWSAssumeRoleCredentialsProvider`: REQUIRED The credentials provider class.
* `aws.credentials.provider.role.arn`: REQUIRED AWS Role ARN providing the access.
* `aws.credentials.provider.session.name`: REQUIRED Session name
* `aws.credentials.provider.external.id`: OPTIONAL (but recommended) External identifier used by the `kafka-connect-lambda` when assuming the role.

### Sample Configuration
```json
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<maven-project-info-reports-plugin.version>3.0.0</maven-project-info-reports-plugin.version>

<kafka.connect-api.version>2.1.0</kafka.connect-api.version>
<aws-java-sdk.version>1.11.587</aws-java-sdk.version>
<aws-java-sdk.version>1.11.592</aws-java-sdk.version>
<junit.version>4.12</junit.version>
<mockito-core.version>2.28.2</mockito-core.version>
<google.guava.version>19.0</google.guava.version>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ enum ConfigurationKeys {
// AWS assume role support options
CREDENTIALS_PROVIDER_CLASS_CONFIG("lambda.credentials.provider.class", "REQUIRED Class providing cross-account role assumption"),
CREDENTIALS_PROVIDER_CLASS_DEFAULT("com.amazonaws.auth.DefaultAWSCredentialsProviderChain", "Default provider chain if lambda.credentials.provider.class is not passed in"),
CREDENTIALS_PROVIDER_CONFIG_PREFIX("lambda.credentials.provider.", "NB: trailing '.'"),
CREDENTIALS_PROVIDER_CONFIG_PREFIX("aws.credentials.provider.", "NB: trailing '.'"),
ROLE_ARN_CONFIG("lambda.credentials.provider.role.arn", " REQUIRED AWS Role ARN providing the access"),
SESSION_NAME_CONFIG("lambda.credentials.provider.session.name", "REQUIRED Session name"),
EXTERNAL_ID_CONFIG("lambda.credentials.provider.external.id", "OPTIONAL (but recommended) External identifier used by the kafka-connect-lambda when assuming the role");
Expand Down

0 comments on commit 2d18713

Please sign in to comment.