diff --git a/docs/multilang/configuring-credential-providers.md b/docs/multilang/configuring-credential-providers.md index d17c84a2..56bde627 100644 --- a/docs/multilang/configuring-credential-providers.md +++ b/docs/multilang/configuring-credential-providers.md @@ -10,9 +10,11 @@ This document should help multilang customers configure a suitable `CredentialPr In a Properties file, an `AwsCredentialsProperty` configuration might look like: ``` -AwsCredentialsProvider = StsAssumeRoleCredentialsProvider|| +AwsCredentialsProvider = StsAssumeRoleCredentialsProvider|||endpointRegion=us-east-1 ``` This basic configuration creates an [StsAssumeRoleCredentialsProvider][sts-assume-provider] with an ARN and session name. +If `endpointRegion` is not specified, the provider will use the region defined in the AWS config file. +If no region is found in the config file, the credentials provider will fail. The providers generated by this config property will be [AWS SDK v2 AwsCredentialsProviders][aws-credentials-provider]. These differ from the SDK v1 AWSCredentialsProviders in a number of ways. See [Credentials Provider Changes][credentials-provider-changes]. @@ -76,7 +78,7 @@ N.B. Backslash (`\`) is for multi-line legibility and is not required. KCL multilang includes a [custom nested property processor for `StsAssumeRole`][kcl-sts-provider]. Multilang configurations that use `StsAssumeRoleSessionCredentialsProvider` need only prefix `Kcl` to exercise this new provider: ``` -AwsCredentialsProvider = KclStsAssumeRoleCredentialsProvider|| +AwsCredentialsProvider = KclStsAssumeRoleCredentialsProvider|||endpointRegion=us-east-1 ``` [aws-credentials-provider]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/auth/credentials/AwsCredentialsProvider.html