Extend withIdentityPoolId signature to allow usage of authenticated identities #30
Conversation
…guration on withIdentityPoolId
| export async function withIdentityPoolId( | ||
| identityPoolId: string, | ||
| options?: Partial<FromCognitoIdentityPoolParameters>, | ||
| ): Promise<MapAuthHelper & SDKAuthHelper> { |
There was a problem hiding this comment.
It deserve a new function than extending withIdentityPoolId.
I would propose a new function like fromCognitoIdentityPool, and call @aws-sdk/credential-providers's fromCognitoIdentityPool with the FromCognitoIdentityPoolParameters without modification. Since this change basically merges everything inside options and customer can supply identityPoolId and region inside FromCognitoIdentityPoolParameters
There was a problem hiding this comment.
Since this change basically merges everything inside options and customer can supply identityPoolId and region inside FromCognitoIdentityPoolParameters
Yes, with the current implementation they could but the information provided in the first param identityPoolId (which is required) will be the one used to invoke the underlying fromCognitoIdentityPool method.
I can make the change you're suggesting but it will require more work and I don't see the point of providing an interface with two different methods name that are doing the same thing. This can be done with an overload (which is what I've proposed in this PR).
I've added a test case that cover the scenario you mention
There was a problem hiding this comment.
Is there a use case that customer can use identity pool without identity pool id (for example, by specifying other parameters)? If there is no suce use case I am OK with overloading.
There was a problem hiding this comment.
no, that's not possible. The underlying method (fromCognitoIdentityPool) would require to provide identityPoolId in the options. Any other field is optional (which is when the overload comes handy).
Issue #, if available:
NA
Description of changes:
The current implementation of the
withIdentityPoolIdmethod does not allow to use authenticated identities to perform actions against the Amazon Location APIs (thus forcing to use only unauthenticated identities). This PR updates the signature of the method mentioned above to expose props that allow to customise the behaviour of thefromCognitoIdentityPoolunderlying API ref.With this change is now possible to use authenticated identities ref to provide access to Amazon Location Service
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.