interface CustomOauth2ProviderConfigInputProperty

Language	Type name
.NET	Amazon.CDK.AWS.BedrockAgentCore.CfnOAuth2CredentialProvider.CustomOauth2ProviderConfigInputProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbedrockagentcore#CfnOAuth2CredentialProvider_CustomOauth2ProviderConfigInputProperty
Java	software.amazon.awscdk.services.bedrockagentcore.CfnOAuth2CredentialProvider.CustomOauth2ProviderConfigInputProperty
Python	aws_cdk.aws_bedrockagentcore.CfnOAuth2CredentialProvider.CustomOauth2ProviderConfigInputProperty
TypeScript	aws-cdk-lib » aws_bedrockagentcore » CfnOAuth2CredentialProvider » CustomOauth2ProviderConfigInputProperty

Input configuration for a custom OAuth2 provider.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html

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 customOauth2ProviderConfigInputProperty: bedrockagentcore.CfnOAuth2CredentialProvider.CustomOauth2ProviderConfigInputProperty = {
  oauthDiscovery: {
    authorizationServerMetadata: {
      authorizationEndpoint: 'authorizationEndpoint',
      issuer: 'issuer',
      tokenEndpoint: 'tokenEndpoint',

      // the properties below are optional
      responseTypes: ['responseTypes'],
    },
    discoveryUrl: 'discoveryUrl',
  },

  // the properties below are optional
  clientAuthenticationMethod: 'clientAuthenticationMethod',
  clientId: 'clientId',
  clientSecret: 'clientSecret',
  clientSecretConfig: {
    jsonKey: 'jsonKey',
    secretId: 'secretId',
  },
  clientSecretSource: 'clientSecretSource',
  onBehalfOfTokenExchangeConfig: {
    grantType: 'grantType',

    // the properties below are optional
    tokenExchangeGrantTypeConfig: {
      actorTokenContent: 'actorTokenContent',

      // the properties below are optional
      actorTokenScopes: ['actorTokenScopes'],
    },
  },
  privateEndpoint: {
    managedVpcResource: {
      endpointIpAddressType: 'endpointIpAddressType',
      subnetIds: ['subnetIds'],
      vpcIdentifier: 'vpcIdentifier',

      // the properties below are optional
      routingDomain: 'routingDomain',
      securityGroupIds: ['securityGroupIds'],
      tags: {
        tagsKey: 'tags',
      },
    },
    selfManagedLatticeResource: {
      resourceConfigurationIdentifier: 'resourceConfigurationIdentifier',
    },
  },
  privateEndpointOverrides: [{
    domain: 'domain',
    privateEndpoint: {
      managedVpcResource: {
        endpointIpAddressType: 'endpointIpAddressType',
        subnetIds: ['subnetIds'],
        vpcIdentifier: 'vpcIdentifier',

        // the properties below are optional
        routingDomain: 'routingDomain',
        securityGroupIds: ['securityGroupIds'],
        tags: {
          tagsKey: 'tags',
        },
      },
      selfManagedLatticeResource: {
        resourceConfigurationIdentifier: 'resourceConfigurationIdentifier',
      },
    },
  }],
  privateKeyJwtConfig: {
    additionalHeaderClaims: {
      additionalHeaderClaimsKey: 'additionalHeaderClaims',
    },
    additionalPayloadClaims: {
      additionalPayloadClaimsKey: 'additionalPayloadClaims',
    },
    privateKeySource: {
      kmsKeySource: {
        kmsKeyArn: 'kmsKeyArn',
      },
    },
    signingAlgorithm: 'signingAlgorithm',
  },
};

Properties

Name	Type	Description
oauthDiscovery	IResolvable | Oauth2DiscoveryProperty	Discovery information for an OAuth2 provider.
clientAuthenticationMethod?	string	The client authentication method to use when authenticating with the token endpoint.
clientId?	string	The client ID for the custom OAuth2 provider.
clientSecret?	string	The client secret for the custom OAuth2 provider.
clientSecretConfig?	IResolvable | SecretReferenceProperty	A reference to a customer-provided secret stored in AWS Secrets Manager.
clientSecretSource?	string	The source of the client secret.
onBehalfOfTokenExchangeConfig?	IResolvable | OnBehalfOfTokenExchangeConfigProperty	Configuration for on-behalf-of token exchange.
privateEndpoint?	IResolvable | PrivateEndpointProperty	The private endpoint configuration for connecting to private resources in your VPC.
privateEndpointOverrides?	IResolvable | (IResolvable | PrivateEndpointOverrideProperty)[]	A list of private endpoint overrides.
privateKeyJwtConfig?	IResolvable | PrivateKeyJwtConfigProperty	Configuration for private_key_jwt client authentication (RFC 7523).

---

oauthDiscovery

Type: IResolvable | Oauth2DiscoveryProperty

Discovery information for an OAuth2 provider.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-oauthdiscovery

---

clientAuthenticationMethod?

Type: string (optional)

The client authentication method to use when authenticating with the token endpoint.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-clientauthenticationmethod

---

clientId?

Type: string (optional)

The client ID for the custom OAuth2 provider.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-clientid

---

clientSecret?

Type: string (optional)

The client secret for the custom OAuth2 provider.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-clientsecret

---

clientSecretConfig?

Type: IResolvable | SecretReferenceProperty (optional)

A reference to a customer-provided secret stored in AWS Secrets Manager.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-clientsecretconfig

---

clientSecretSource?

Type: string (optional)

The source of the client secret.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-clientsecretsource

---

onBehalfOfTokenExchangeConfig?

Type: IResolvable | OnBehalfOfTokenExchangeConfigProperty (optional)

Configuration for on-behalf-of token exchange.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-onbehalfoftokenexchangeconfig

---

privateEndpoint?

Type: IResolvable | PrivateEndpointProperty (optional)

The private endpoint configuration for connecting to private resources in your VPC.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-privateendpoint

---

privateEndpointOverrides?

Type: IResolvable | (IResolvable | PrivateEndpointOverrideProperty)[] (optional)

A list of private endpoint overrides.

Each override maps a specific domain to a private endpoint, enabling secure connectivity through VPC Lattice resource configurations.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-privateendpointoverrides

---

privateKeyJwtConfig?

Type: IResolvable | PrivateKeyJwtConfigProperty (optional)

Configuration for private_key_jwt client authentication (RFC 7523).

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-privatekeyjwtconfig