class GatewayCredentialProvider
| Language | Type name |
|---|---|
.NET | Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.GatewayCredentialProvider |
Go | github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#GatewayCredentialProvider |
Java | software.amazon.awscdk.services.bedrock.agentcore.alpha.GatewayCredentialProvider |
Python | aws_cdk.aws_bedrock_agentcore_alpha.GatewayCredentialProvider |
TypeScript (source) | @aws-cdk/aws-bedrock-agentcore-alpha » GatewayCredentialProvider |
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Factory class for creating different Gateway Credential Providers.
Initializer
new GatewayCredentialProvider()
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Methods
| Name | Description |
|---|---|
| static from | Create an API key outbound auth configuration from a Token Vault {@link IApiKeyCredentialProvider} construct. |
| static from | Create an API key credential provider from Identity ARN Use this method when you have the Identity ARN as a string. |
| static from | Create an IAM role credential provider. |
| static from | Create an OAuth outbound auth configuration from a Token Vault {@link IOAuth2CredentialProvider} construct. |
| static from | Create an OAuth credential provider from Identity ARN Use this method when you have the Identity ARN as a string. |
static fromApiKeyIdentity(provider, options?)
public static fromApiKeyIdentity(provider: IApiKeyCredentialProvider, options?: FromApiKeyIdentityOptions): ICredentialProviderConfig
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- provider
IApiKey Credential Provider - options
FromApi Key Identity Options
Returns
Create an API key outbound auth configuration from a Token Vault {@link IApiKeyCredentialProvider} construct.
Prefer this over {@link GatewayCredentialProvider.fromApiKeyIdentityArn} when the provider is defined in CDK.
static fromApiKeyIdentityArn(props)
public static fromApiKeyIdentityArn(props: ApiKeyCredentialProviderProps): ICredentialProviderConfig
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- props
Api— - The configuration properties for the API key credential provider.Key Credential Provider Props
Returns
Create an API key credential provider from Identity ARN Use this method when you have the Identity ARN as a string.
static fromIamRole()
public static fromIamRole(): ICredentialProviderConfig
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Returns
Create an IAM role credential provider.
static fromOauthIdentity(provider, options)
public static fromOauthIdentity(provider: IOAuth2CredentialProvider, options: FromOauthIdentityOptions): ICredentialProviderConfig
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- provider
IOAuth2Credential Provider - options
FromOauth Identity Options
Returns
Create an OAuth outbound auth configuration from a Token Vault {@link IOAuth2CredentialProvider} construct.
Prefer this over {@link GatewayCredentialProvider.fromOauthIdentityArn} when the provider is defined in CDK.
static fromOauthIdentityArn(props)
public static fromOauthIdentityArn(props: OAuthConfiguration): ICredentialProviderConfig
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- props
OAuth— - The configuration properties for the OAuth credential provider.Configuration
Returns
Create an OAuth credential provider from Identity ARN Use this method when you have the Identity ARN as a string.

.NET
Go
Java
Python
TypeScript (