interface GatewayOAuth2IdentityBinding

Language	Type name
.NET	Amazon.CDK.AWS.BedrockAgentCore.GatewayOAuth2IdentityBinding
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbedrockagentcore#GatewayOAuth2IdentityBinding
Java	software.amazon.awscdk.services.bedrockagentcore.GatewayOAuth2IdentityBinding
Python	aws_cdk.aws_bedrockagentcore.GatewayOAuth2IdentityBinding
TypeScript (source)	aws-cdk-lib » aws_bedrockagentcore » 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 { aws_bedrockagentcore as bedrockagentcore } from 'aws-cdk-lib';
const gatewayOAuth2IdentityBinding: bedrockagentcore.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.