interface GatewayOAuth2IdentityBinding 🔹

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

Obtainable from OAuth2CredentialProvider.bindForGatewayOAuthTarget()

Provider ARN, secret ARN, and OAuth scopes for wiring a Token Vault OAuth2 identity into a gateway target.

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 gatewayOAuth2IdentityBinding: bedrock_agentcore_alpha.GatewayOAuth2IdentityBinding = {
  providerArn: 'providerArn',
  scopes: ['scopes'],
  secretArn: 'secretArn',

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

Properties

Name	Type	Description
providerArn🔹	string	OAuth2 credential provider ARN.
scopes🔹	string[]	OAuth scopes to request when invoking through the gateway.
secretArn🔹	string	Secrets Manager secret ARN for OAuth2 client credentials.
customParameters?🔹	{ [string]: string }	Optional custom parameters for the OAuth flow.

---

providerArn🔹

Type: string

OAuth2 credential provider ARN.

---

scopes🔹

Type: string[]

OAuth scopes to request when invoking through the gateway.

---

secretArn🔹

Type: string

Secrets Manager secret ARN for OAuth2 client credentials.

---

customParameters?🔹

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

Optional custom parameters for the OAuth flow.