interface Oauth2ProviderConfigOutputProperty

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

Output configuration for an OAuth2 provider.

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 oauth2ProviderConfigOutputProperty: bedrockagentcore.CfnOAuth2CredentialProvider.Oauth2ProviderConfigOutputProperty = {
  clientAuthenticationMethod: 'clientAuthenticationMethod',
  clientId: 'clientId',
  oauthDiscovery: {
    authorizationServerMetadata: {
      authorizationEndpoint: 'authorizationEndpoint',
      issuer: 'issuer',
      tokenEndpoint: 'tokenEndpoint',

      // the properties below are optional
      responseTypes: ['responseTypes'],
    },
    discoveryUrl: 'discoveryUrl',
  },
  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
clientAuthenticationMethod?	`string`	The client authentication method used when authenticating with the token endpoint.
clientId?	`string`
oauthDiscovery?	`IResolvable` `\|` `Oauth2DiscoveryProperty`	Discovery information for an OAuth2 provider.
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)[]`	The list of private endpoint overrides for the OAuth2 provider.
privateKeyJwtConfig?	`IResolvable` `\|` `PrivateKeyJwtConfigProperty`	Configuration for private_key_jwt client authentication (RFC 7523).

clientAuthenticationMethod?

Type: string (optional)

The client authentication method used when authenticating with the token endpoint.

clientId?

Type: string (optional)

oauthDiscovery?

Type: IResolvable | Oauth2DiscoveryProperty (optional)

Discovery information for an OAuth2 provider.

onBehalfOfTokenExchangeConfig?

Type: IResolvable | OnBehalfOfTokenExchangeConfigProperty (optional)

Configuration for on-behalf-of token exchange.

privateEndpoint?

Type: IResolvable | PrivateEndpointProperty (optional)

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

privateEndpointOverrides?

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

The list of private endpoint overrides for the OAuth2 provider.

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

privateKeyJwtConfig?

Type: IResolvable | PrivateKeyJwtConfigProperty (optional)

Configuration for private_key_jwt client authentication (RFC 7523).

AWS CDK

2.269.0