2.256.0

class RuntimeAuthorizerConfiguration 🔹

LanguageType name
.NETAmazon.CDK.AWS.Bedrock.Agentcore.Alpha.RuntimeAuthorizerConfiguration
Gogithub.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#RuntimeAuthorizerConfiguration
Javasoftware.amazon.awscdk.services.bedrock.agentcore.alpha.RuntimeAuthorizerConfiguration
Pythonaws_cdk.aws_bedrock_agentcore_alpha.RuntimeAuthorizerConfiguration
TypeScript (source)@aws-cdk/aws-bedrock-agentcore-alpha » RuntimeAuthorizerConfiguration

Abstract base class for runtime authorizer configurations.

Provides static factory methods to create different authentication types.

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 { aws_cognito as cognito } from 'aws-cdk-lib';

declare const runtimeCustomClaim: bedrock_agentcore_alpha.RuntimeCustomClaim;
declare const userPool: cognito.UserPool;
declare const userPoolClient: cognito.UserPoolClient;
const runtimeAuthorizerConfiguration = bedrock_agentcore_alpha.RuntimeAuthorizerConfiguration.usingCognito(userPool, [userPoolClient], /* all optional props */ ['allowedAudience'], /* all optional props */ ['allowedScopes'], /* all optional props */ [runtimeCustomClaim]);

Initializer

new RuntimeAuthorizerConfiguration()

Methods

NameDescription
static usingCognito(userPool, userPoolClients, allowedAudience?, allowedScopes?, customClaims?)🔹Use AWS Cognito User Pool authentication.
static usingIAM()🔹Use IAM authentication (default).
static usingJWT(discoveryUrl, allowedClients?, allowedAudience?, allowedScopes?, customClaims?)🔹Use custom JWT authentication.
static usingOAuth(discoveryUrl, clientId, allowedAudience?, allowedScopes?, customClaims?)🔹Use OAuth 2.0 authentication. Supports various OAuth providers.

static usingCognito(userPool, userPoolClients, allowedAudience?, allowedScopes?, customClaims?)🔹

public static usingCognito(userPool: IUserPool, userPoolClients: IUserPoolClient[], allowedAudience?: string[], allowedScopes?: string[], customClaims?: RuntimeCustomClaim[]): RuntimeAuthorizerConfiguration

Parameters

  • userPool IUserPool — The Cognito User Pool.
  • userPoolClients IUserPoolClient[] — The Cognito User Pool App Clients.
  • allowedAudience string[] — Optional array of allowed audiences.
  • allowedScopes string[] — Optional array of allowed scopes.
  • customClaims RuntimeCustomClaim[] — Optional array of custom claim validations.

Returns

Use AWS Cognito User Pool authentication.

Validates Cognito-issued JWT tokens.

static usingIAM()🔹

public static usingIAM(): RuntimeAuthorizerConfiguration

Returns

Use IAM authentication (default).

Requires AWS credentials to sign requests using SigV4.

static usingJWT(discoveryUrl, allowedClients?, allowedAudience?, allowedScopes?, customClaims?)🔹

public static usingJWT(discoveryUrl: string, allowedClients?: string[], allowedAudience?: string[], allowedScopes?: string[], customClaims?: RuntimeCustomClaim[]): RuntimeAuthorizerConfiguration

Parameters

  • discoveryUrl string — The OIDC discovery URL (must end with /.well-known/openid-configuration).
  • allowedClients string[] — Optional array of allowed client IDs.
  • allowedAudience string[] — Optional array of allowed audiences.
  • allowedScopes string[] — Optional array of allowed scopes.
  • customClaims RuntimeCustomClaim[] — Optional array of custom claim validations.

Returns

Use custom JWT authentication.

Validates JWT tokens against the specified OIDC provider.

static usingOAuth(discoveryUrl, clientId, allowedAudience?, allowedScopes?, customClaims?)🔹

public static usingOAuth(discoveryUrl: string, clientId: string, allowedAudience?: string[], allowedScopes?: string[], customClaims?: RuntimeCustomClaim[]): RuntimeAuthorizerConfiguration

Parameters

  • discoveryUrl string — The OIDC discovery URL (must end with /.well-known/openid-configuration).
  • clientId string — OAuth client ID.
  • allowedAudience string[] — Optional array of allowed audiences.
  • allowedScopes string[] — Optional array of allowed scopes.
  • customClaims RuntimeCustomClaim[] — Optional array of custom claim validations.

Returns

Use OAuth 2.0 authentication. Supports various OAuth providers.

← PreviousNext →