interface IncludedOauth2TenantCredentialProviderProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.IncludedOauth2TenantCredentialProviderProps |
 Go | github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#IncludedOauth2TenantCredentialProviderProps |
 Java | software.amazon.awscdk.services.bedrock.agentcore.alpha.IncludedOauth2TenantCredentialProviderProps |
 Python | aws_cdk.aws_bedrock_agentcore_alpha.IncludedOauth2TenantCredentialProviderProps |
 TypeScript (source) | @aws-cdk/aws-bedrock-agentcore-alpha » IncludedOauth2TenantCredentialProviderProps |
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Implements
OAuth2, OAuth2, OAuth2, Included
Props for IncludedOauth2ProviderConfig IdPs whose outbound documentation requires issuer, authorizationEndpoint, and/or tokenEndpoint (for example Okta, Auth0, Amazon Cognito, OneLogin, PingOne, CyberArk, FusionAuth).
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';
import * as cdk from 'aws-cdk-lib';
declare const secretValue: cdk.SecretValue;
const includedOauth2TenantCredentialProviderProps: bedrock_agentcore_alpha.IncludedOauth2TenantCredentialProviderProps = {
clientId: 'clientId',
clientSecret: secretValue,
// the properties below are optional
authorizationEndpoint: 'authorizationEndpoint',
issuer: 'issuer',
oAuth2CredentialProviderName: 'oAuth2CredentialProviderName',
tags: {
tagsKey: 'tags',
},
tokenEndpoint: 'tokenEndpoint',
};
Properties
| Name | Type | Description |
|---|---|---|
| client | string | OAuth2 client identifier. |
| client | Secret | OAuth2 client secret. |
| authorization | string | OAuth2 authorization endpoint for your tenant. |
| issuer? | string | Token issuer URL for your tenant (often the IdP base or issuer URI). |
| o | string | Name of the credential provider. |
| tags? | { [string]: string } | Tags for this credential provider. |
| token | string | OAuth2 token endpoint for your tenant. |
clientId
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
string
OAuth2 client identifier.
clientSecret
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
Secret
OAuth2 client secret.
NOTE: The client secret will be included in the CloudFormation template as part of synthesis.
The service stores the secret in Secrets Manager after creation, but the value is visible
in the template and deployment history. Use SecretValue.unsafePlainText() to explicitly
acknowledge plaintext, or pass a reference from another construct to avoid embedding the
literal value.
authorizationEndpoint?
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
string
(optional, default: not specified; use when your IdP requires an explicit endpoint)
OAuth2 authorization endpoint for your tenant.
issuer?
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
string
(optional, default: not specified; use when your IdP requires an explicit issuer)
Token issuer URL for your tenant (often the IdP base or issuer URI).
oAuth2CredentialProviderName?
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
string
(optional, default: a name generated by CDK)
Name of the credential provider.
tags?
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
{ [string]: string }
(optional, default: no tags)
Tags for this credential provider.
tokenEndpoint?
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
string
(optional, default: not specified; use when your IdP requires an explicit endpoint)
OAuth2 token endpoint for your tenant.