interface OAuth2CredentialProviderProps
| Language | Type name |
|---|---|
.NET | Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.OAuth2CredentialProviderProps |
Go | github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#OAuth2CredentialProviderProps |
Java | software.amazon.awscdk.services.bedrock.agentcore.alpha.OAuth2CredentialProviderProps |
Python | aws_cdk.aws_bedrock_agentcore_alpha.OAuth2CredentialProviderProps |
TypeScript (source) | @aws-cdk/aws-bedrock-agentcore-alpha ยป OAuth2CredentialProviderProps |
Low-level properties when you need full control (prefer {@link OAuth2CredentialProvider.usingSlack} and other factories).
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';
const oAuth2CredentialProviderProps: bedrock_agentcore_alpha.OAuth2CredentialProviderProps = {
credentialProviderVendor: 'credentialProviderVendor',
oauth2ProviderConfigInput: {
atlassianOauth2ProviderConfig: {
clientId: 'clientId',
clientSecret: 'clientSecret',
},
customOauth2ProviderConfig: {
oauthDiscovery: {
authorizationServerMetadata: {
authorizationEndpoint: 'authorizationEndpoint',
issuer: 'issuer',
tokenEndpoint: 'tokenEndpoint',
// the properties below are optional
responseTypes: ['responseTypes'],
},
discoveryUrl: 'discoveryUrl',
},
// the properties below are optional
clientId: 'clientId',
clientSecret: 'clientSecret',
onBehalfOfTokenExchangeConfig: {
grantType: 'grantType',
// the properties below are optional
tokenExchangeGrantTypeConfig: {
actorTokenContent: 'actorTokenContent',
// the properties below are optional
actorTokenScopes: ['actorTokenScopes'],
},
},
},
githubOauth2ProviderConfig: {
clientId: 'clientId',
clientSecret: 'clientSecret',
},
googleOauth2ProviderConfig: {
clientId: 'clientId',
clientSecret: 'clientSecret',
},
includedOauth2ProviderConfig: {
clientId: 'clientId',
clientSecret: 'clientSecret',
// the properties below are optional
authorizationEndpoint: 'authorizationEndpoint',
issuer: 'issuer',
tokenEndpoint: 'tokenEndpoint',
},
linkedinOauth2ProviderConfig: {
clientId: 'clientId',
clientSecret: 'clientSecret',
},
microsoftOauth2ProviderConfig: {
clientId: 'clientId',
clientSecret: 'clientSecret',
// the properties below are optional
tenantId: 'tenantId',
},
salesforceOauth2ProviderConfig: {
clientId: 'clientId',
clientSecret: 'clientSecret',
},
slackOauth2ProviderConfig: {
clientId: 'clientId',
clientSecret: 'clientSecret',
},
},
// the properties below are optional
oAuth2CredentialProviderName: 'oAuth2CredentialProviderName',
tags: {
tagsKey: 'tags',
},
};
Properties
| Name | Type | Description |
|---|---|---|
| credential | string | OAuth2 vendor string for CloudFormation CredentialProviderVendor. |
| oauth2 | Oauth2 | OAuth2 provider configuration passed through to Oauth2ProviderConfigInput. |
| o | string | Name of the credential provider. |
| tags? | { [string]: string } | Tags for this credential provider. |
credentialProviderVendor
Type:
string
OAuth2 vendor string for CloudFormation CredentialProviderVendor.
oauth2ProviderConfigInput
Type:
Oauth2
OAuth2 provider configuration passed through to Oauth2ProviderConfigInput.
oAuth2CredentialProviderName?
Type:
string
(optional, default: a name generated by CDK)
Name of the credential provider.
tags?
Type:
{ [string]: string }
(optional, default: no tags)
Tags for this credential provider.

.NET
Go
Java
Python
TypeScript (