Skip to content
v2.275.0

Oauth2ProviderConfigOutputProperty Struct ​

Output configuration for an OAuth2 provider.

Example ​

ts
// 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 ​

clientAuthenticationMethodoptionalstringclient_authentication_methodoptionalstrclientAuthenticationMethodoptionalStringClientAuthenticationMethodoptionalstringClientAuthenticationMethodoptional*string#
The client authentication method used when authenticating with the token endpoint.
clientIdoptionalstringclient_idoptionalstrclientIdoptionalStringClientIdoptionalstringClientIdoptional*string#
oauthDiscoveryoptionalIResolvable | CfnOAuth2CredentialProvider.Oauth2DiscoveryPropertyoauth_discoveryoptionaltyping.Union[IResolvable, Oauth2DiscoveryProperty]oauthDiscoveryoptionalIResolvableOauthDiscoveryoptionalIResolvableOauthDiscoveryoptionalinterface{}#
Discovery information for an OAuth2 provider.
onBehalfOfTokenExchangeConfigoptionalIResolvable | CfnOAuth2CredentialProvider.OnBehalfOfTokenExchangeConfigPropertyon_behalf_of_token_exchange_configoptionaltyping.Union[IResolvable, OnBehalfOfTokenExchangeConfigProperty]onBehalfOfTokenExchangeConfigoptionalIResolvableOnBehalfOfTokenExchangeConfigoptionalIResolvableOnBehalfOfTokenExchangeConfigoptionalinterface{}#
Configuration for on-behalf-of token exchange.
privateEndpointoptionalIResolvable | CfnOAuth2CredentialProvider.PrivateEndpointPropertyprivate_endpointoptionaltyping.Union[IResolvable, PrivateEndpointProperty]privateEndpointoptionalIResolvablePrivateEndpointoptionalIResolvablePrivateEndpointoptionalinterface{}#
The private endpoint configuration for connecting to private resources in your VPC.
privateEndpointOverridesoptionalIResolvable | IResolvable | CfnOAuth2CredentialProvider.PrivateEndpointOverrideProperty[]private_endpoint_overridesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PrivateEndpointOverrideProperty]]]privateEndpointOverridesoptionalIResolvablePrivateEndpointOverridesoptionalIResolvablePrivateEndpointOverridesoptionalinterface{}#
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.

privateKeyJwtConfigoptionalIResolvable | CfnOAuth2CredentialProvider.PrivateKeyJwtConfigPropertyprivate_key_jwt_configoptionaltyping.Union[IResolvable, PrivateKeyJwtConfigProperty]privateKeyJwtConfigoptionalIResolvablePrivateKeyJwtConfigoptionalIResolvablePrivateKeyJwtConfigoptionalinterface{}#
Configuration for private_key_jwt client authentication (RFC 7523).