-
Notifications
You must be signed in to change notification settings - Fork 14
APIGOV-32898 AgentCore documentation #879
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
48 changes: 48 additions & 0 deletions
48
...connect_manage_environ/connect_aws_gateway/credential-provisioning-agentcore.md
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| --- | ||
| title: Credential provisioning for AgentCore gateways | ||
| linkTitle: Credential provisioning - AgentCore | ||
| draft: false | ||
| weight: 55 | ||
| --- | ||
| When a consumer subscribes to an API service discovered from an AgentCore gateway, the Provisioning Agent automatically creates and manages credentials in the authorizer service linked to that gateway. The type of credentials depends on the gateway's authorizer configuration. | ||
|
|
||
| ## Before you start | ||
|
|
||
| * AgentCore mode must be configured. See [AgentCore Gateway mode configuration](/docs/connect_manage_environ/connect_aws_gateway/deploy-your-agents-1/#agentcore-gateway-mode-configuration). | ||
| * For gateways using CUSTOM_JWT authorization, at least one Cognito User Pool must be configured via `AWS_COGNITO_USERPOOLID_N` and `AWS_COGNITO_REGION_N`. | ||
| * The agent's IAM policy must include the [Provisioning permissions](/docs/connect_manage_environ/connect_aws_gateway/embedded-aws-agent-setup/#provisioning-policy). | ||
|
|
||
| ## Objectives | ||
|
|
||
| Learn about the available Credential Request Definitions (CRDs) for AgentCore gateways and how credentials are created and removed for Cognito-secured and IAM-secured gateways. | ||
|
|
||
| ## Available credential request definitions | ||
|
|
||
| The agent assigns a Credential Request Definition (CRD) to each discovered API service based on the gateway's authorizer type: | ||
|
|
||
| | Gateway authorizer | CRD name | Notes | | ||
| | --- | --- | --- | | ||
| | `CUSTOM_JWT` (Cognito issuer) | `cognito-{user-pool-id}` | Assigned when the issuer URL matches a configured Cognito User Pool. The pool ID is normalized to lowercase with underscores replaced by hyphens. For example, pool `eu-west-1_cEL0M3519` produces CRD name `cognito-eu-west-1-cel0m3519`. | | ||
| | `AWS_IAM` | `aws-iam` | Assigned only when `AWS_AGENTCORE_IAMAUTHENABLED=true`. The gateway is still discovered and published without a CRD when this flag is `false`. | | ||
| | `NONE` | *(none)* | No credentials are required; no CRD is assigned. | | ||
|
|
||
| ## Cognito credential lifecycle | ||
|
|
||
| ### On subscription | ||
|
|
||
| The Provisioning Agent creates a new app client in the configured Cognito User Pool. The returned `client_id` and `client_secret` are delivered to the consumer. The client ID is also added to the gateway's `allowedClients` list via `bedrock-agentcore:UpdateGateway`. | ||
|
|
||
| ### On unsubscription | ||
|
|
||
| The Provisioning Agent deletes the app client from the Cognito User Pool and removes the client ID from the gateway's `allowedClients` list. | ||
|
|
||
| ## IAM credential handling | ||
|
|
||
| Gateways with `AWS_IAM` authorizer are always discovered and published to Amplify. When `AWS_AGENTCORE_IAMAUTHENABLED=true`, the published service is associated with the `aws-iam` CRD, allowing consumers to request credentials through Amplify. When the flag is `false`, the gateway is published without a CRD — it is visible in Amplify but no managed credential flow is available. | ||
|
|
||
| No external credential resources are created in either case. Consumers authenticate using their own AWS credentials with the appropriate IAM permissions to invoke the gateway. | ||
|
|
||
| ## Related topics | ||
|
|
||
| * [AWS IAM policy for AgentCore mode](/docs/connect_manage_environ/connect_aws_gateway/embedded-aws-agent-setup/#aws-iam-policy-for-agentcore-mode) | ||
| * [AgentCore Gateway mode configuration](/docs/connect_manage_environ/connect_aws_gateway/deploy-your-agents-1/#agentcore-gateway-mode-configuration) |
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
May be "AWS API Gateway / AWS Bedrock AgentCore" instead of "AWS API Gateway or AWS Bedrock AgentCore Gateway"
Would suggest to drop "Gateway" just use "AWS Bedrock AgentCore" thats the service name