Package software.amazon.awscdk.services.bedrockagentcore

Class GatewayAuthorizer

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.bedrockagentcore.GatewayAuthorizer

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.130.0 (build 048a5ee)",
           date="2026-05-19T19:44:37.082Z")
@Stability(Stable)
public abstract class GatewayAuthorizer
extends software.amazon.jsii.JsiiObject

Factory class for creating Gateway Authorizers.

Example:

 // Optional: Create custom claims (CustomClaimOperator and GatewayCustomClaim from agentcore)
 GatewayCustomClaim[] customClaims = List.of(GatewayCustomClaim.withStringValue("department", "engineering"), GatewayCustomClaim.withStringArrayValue("roles", List.of("admin"), CustomClaimOperator.CONTAINS), GatewayCustomClaim.withStringArrayValue("permissions", List.of("read", "write"), CustomClaimOperator.CONTAINS_ANY));
 Gateway gateway = Gateway.Builder.create(this, "MyGateway")
         .gatewayName("my-gateway")
         .authorizerConfiguration(GatewayAuthorizer.usingCustomJwt(CustomJwtConfiguration.builder()
                 .discoveryUrl("https://auth.example.com/.well-known/openid-configuration")
                 .allowedAudience(List.of("my-app"))
                 .allowedClients(List.of("my-client-id"))
                 .allowedScopes(List.of("read", "write"))
                 .customClaims(customClaims)
                 .build()))
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GatewayAuthorizer()
protected	GatewayAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	GatewayAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static IGatewayAuthorizerConfig	usingAwsIam()	AWS IAM authorizer instance.
static IGatewayAuthorizerConfig	usingCognito(CognitoAuthorizerProps props)	Create a JWT authorizer from Cognito User Pool.
static IGatewayAuthorizerConfig	usingCustomJwt(CustomJwtConfiguration configuration)	Create a custom JWT authorizer.
static IGatewayAuthorizerConfig	withNoAuth()	No authorization — the gateway will not perform any inbound authorization.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

GatewayAuthorizer

protected GatewayAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)

GatewayAuthorizer

protected GatewayAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

GatewayAuthorizer

@Stability(Stable)
protected GatewayAuthorizer()

Method Details

usingAwsIam

@Stability(Stable)
@NotNull
public static IGatewayAuthorizerConfig usingAwsIam()

AWS IAM authorizer instance.

usingCognito

@Stability(Stable)
@NotNull
public static IGatewayAuthorizerConfig usingCognito(@NotNull
 CognitoAuthorizerProps props)

Create a JWT authorizer from Cognito User Pool.

Parameters:

props -

• The Cognito configuration.

This parameter is required.

Returns:

CustomJwtAuthorizer configured for Cognito

usingCustomJwt

@Stability(Stable)
@NotNull
public static IGatewayAuthorizerConfig usingCustomJwt(@NotNull
 CustomJwtConfiguration configuration)

Create a custom JWT authorizer.

Parameters:

configuration -

• The JWT configuration.

This parameter is required.

Returns:

IGatewayAuthorizerConfig configured for custom JWT

withNoAuth

@Stability(Stable)
@NotNull
public static IGatewayAuthorizerConfig withNoAuth()

No authorization — the gateway will not perform any inbound authorization.

The gateway endpoint will be publicly accessible without credentials. Use this for testing/development, or for production gateways where you have implemented compensating controls such as Gateway Interceptors.

Returns:

IGatewayAuthorizerConfig configured for no authorization

See Also:

• https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/gateway-inbound-auth.html#gateway-inbound-auth-none