interface OAuthConfiguration 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.OAuthConfiguration
Go	github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#OAuthConfiguration
Java	software.amazon.awscdk.services.bedrock.agentcore.alpha.OAuthConfiguration
Python	aws_cdk.aws_bedrock_agentcore_alpha.OAuthConfiguration
TypeScript (source)	@aws-cdk/aws-bedrock-agentcore-alpha » OAuthConfiguration

OAuth configuration.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';
const oAuthConfiguration: bedrock_agentcore_alpha.OAuthConfiguration = {
  providerArn: 'providerArn',
  scopes: ['scopes'],
  secretArn: 'secretArn',

  // the properties below are optional
  customParameters: {
    customParametersKey: 'customParameters',
  },
};

Properties

Name	Type	Description
providerArn🔹	string	The OAuth credential provider ARN.
scopes🔹	string[]	The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.
secretArn🔹	string	The ARN of the Secrets Manager secret containing OAuth credentials (client ID and secret).
customParameters?🔹	{ [string]: string }	Custom parameters for the OAuth flow.

---

providerArn🔹

Type: string

The OAuth credential provider ARN.

This is returned when creating the OAuth credential provider via Console or API. Format: arn:aws:bedrock-agentcore:region:account:token-vault/id/oauth2credentialprovider/name Required: Yes

---

scopes🔹

Type: string[]

The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.

Array Members: Minimum number of 0 items. Maximum number of 100 items. Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes

---

secretArn🔹

Type: string

The ARN of the Secrets Manager secret containing OAuth credentials (client ID and secret).

This is returned when creating the OAuth credential provider via Console or API. Format: arn:aws:secretsmanager:region:account:secret:name Required: Yes

---

customParameters?🔹

Type: { [string]: string } (optional, default: No custom parameters)

Custom parameters for the OAuth flow.