aws-cdk-lib.aws_bedrockagentcore.GatewayOAuth2IdentityBinding

GatewayOAuth2IdentityBinding Struct

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

Source

aws-bedrockagentcore/lib/identity/oauth2-credential-provider.ts

Type last changed

v2.255.0 · 19 May 2026

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

customParameters?optional{ [key: string]: string }custom_parameters?optionaltyping.Mapping[str, str]customParameters?optionalMap<String, String>CustomParameters?optionalIDictionary<string, string>CustomParameters?optional*map[string]*string#

Optional custom parameters for the OAuth flow.

Default: no custom parameters

providerArnstringprovider_arnstrproviderArnStringProviderArnstringProviderArn*stringrequired#

OAuth2 credential provider ARN.

scopesstring[]scopestyping.List[str]scopesList<String>Scopesstring[]Scopes*[]*stringrequired#

OAuth scopes to request when invoking through the gateway.

secretArnstringsecret_arnstrsecretArnStringSecretArnstringSecretArn*stringrequired#

Secrets Manager secret ARN for OAuth2 client credentials.