chore(apigateway): improve docs and default value settings for identity source in authorizer #28214
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
p2
star-contributor
go-to-k
commented
Dec 1, 2023
| @@ -78,7 +80,7 @@ export class CognitoUserPoolsAuthorizer extends Authorizer implements IAuthorize | |||
| type: 'COGNITO_USER_POOLS', | |||
| providerArns: props.cognitoUserPools.map(userPool => userPool.userPoolArn), | |||
| authorizerResultTtlInSeconds: props.resultsCacheTtl?.toSeconds(), | |||
| identitySource: props.identitySource || 'method.request.header.Authorization', | |||
| identitySource: props.identitySource || IdentitySource.header('Authorization'), | |||
There was a problem hiding this comment.
The change caused by this is guaranteed by this test.
go-to-k
commented
Dec 1, 2023
| @@ -216,7 +218,7 @@ export class TokenAuthorizer extends LambdaAuthorizer { | |||
| authorizerUri: lambdaAuthorizerArn(props.handler), | |||
| authorizerCredentials: props.assumeRole?.roleArn, | |||
| authorizerResultTtlInSeconds: props.resultsCacheTtl?.toSeconds() ?? Duration.minutes(5).toSeconds(), | |||
| identitySource: props.identitySource || 'method.request.header.Authorization', | |||
| identitySource: props.identitySource || IdentitySource.header('Authorization'), | |||
There was a problem hiding this comment.
The change caused by this is guaranteed by this test.
go-to-k
commented
Dec 1, 2023
| * @see https://docs.aws.amazon.com/apigateway/api-reference/link-relation/authorizer-create/#identitySource | ||
| * this should be `method.request.header.Authorizer` where `Authorizer` is the header containing the bearer token. | ||
| * | ||
| * @see https://docs.aws.amazon.com/apigateway/latest/api/API_CreateAuthorizer.html#apigw-CreateAuthorizer-request-identitySource | ||
| * @default `IdentitySource.header('Authorization')` |
There was a problem hiding this comment.
The default value setting process has been changed to fit here.
go-to-k
commented
Dec 1, 2023
| * @see https://docs.aws.amazon.com/apigateway/api-reference/link-relation/authorizer-create/#identitySource | ||
| * this should be `method.request.header.Authorizer` where `Authorizer` is the header containing the bearer token. | ||
| * | ||
| * @see https://docs.aws.amazon.com/apigateway/latest/api/API_CreateAuthorizer.html#apigw-CreateAuthorizer-request-identitySource | ||
| * @default `IdentitySource.header('Authorization')` |
There was a problem hiding this comment.
The default value setting process has been changed to fit here.
aws-cdk-automation
added
the
pr/needs-community-review
aws-cdk-automation
added
pr/needs-maintainer-review
sumupitchayan
approved these changes
Dec 4, 2023
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
aws-cdk-automation
removed
the
pr/needs-maintainer-review
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
chenjane-dev
pushed a commit
to chenjane-dev/aws-cdk
that referenced
this pull request
Dec 5, 2023
…ty source in authorizer (aws#28214) Addressed the following points about Authorizer's `identitySource` property. - Reference link is broken. - now: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/authorizer-create/#identitySource - new: https://docs.aws.amazon.com/apigateway/latest/api/API_CreateAuthorizer.html#apigw-CreateAuthorizer-request-identitySource - One explanation was confusing, so I enclosed it in quotes. - now: ```this should be `method.request.header.Authorizer` where Authorizer is the header containing the bearer token.``` - new: ```this should be `method.request.header.Authorizer` where `Authorizer` is the header containing the bearer token.``` - Not using the static method written in the doc to set default values when a prop is not specified. - now: `'method.request.header.Authorization'` - new: `IdentitySource.header('Authorization')` ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addressed the following points about Authorizer's
identitySourceproperty.this should be `method.request.header.Authorizer` where Authorizer is the header containing the bearer token.this should be `method.request.header.Authorizer` where `Authorizer` is the header containing the bearer token.'method.request.header.Authorization'IdentitySource.header('Authorization')By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license