Package software.amazon.awscdk.services.bedrockagentcore

Interface GatewayOAuth2IdentityBinding

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GatewayOAuth2IdentityBinding.Jsii$Proxy

@Generated(value="jsii-pacmak/1.129.0 (build eaca441)",
           date="2026-05-19T08:18:44.411Z")
@Stability(Stable)
public interface GatewayOAuth2IdentityBinding
extends software.amazon.jsii.JsiiSerializable

Provider ARN, secret ARN, and OAuth scopes for wiring a Token Vault OAuth2 identity into a gateway target.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrockagentcore.*;
 GatewayOAuth2IdentityBinding gatewayOAuth2IdentityBinding = GatewayOAuth2IdentityBinding.builder()
         .providerArn("providerArn")
         .scopes(List.of("scopes"))
         .secretArn("secretArn")
         // the properties below are optional
         .customParameters(Map.of(
                 "customParametersKey", "customParameters"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	GatewayOAuth2IdentityBinding.Builder	A builder for GatewayOAuth2IdentityBinding
static final class	GatewayOAuth2IdentityBinding.Jsii$Proxy	An implementation for GatewayOAuth2IdentityBinding

Method Summary

Modifier and Type	Method	Description
static GatewayOAuth2IdentityBinding.Builder	builder()
default Map<String,String>	getCustomParameters()	Optional custom parameters for the OAuth flow.
String	getProviderArn()	OAuth2 credential provider ARN.
List<String>	getScopes()	OAuth scopes to request when invoking through the gateway.
String	getSecretArn()	Secrets Manager secret ARN for OAuth2 client credentials.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getProviderArn

@Stability(Stable)
@NotNull
String getProviderArn()

OAuth2 credential provider ARN.

getScopes

@Stability(Stable)
@NotNull
List<String> getScopes()

OAuth scopes to request when invoking through the gateway.

getSecretArn

@Stability(Stable)
@NotNull
String getSecretArn()

Secrets Manager secret ARN for OAuth2 client credentials.

getCustomParameters

@Stability(Stable)
@Nullable
default Map<String,String> getCustomParameters()

Optional custom parameters for the OAuth flow.

Default: - no custom parameters

builder

@Stability(Stable)
static GatewayOAuth2IdentityBinding.Builder builder()

Returns:

a GatewayOAuth2IdentityBinding.Builder of GatewayOAuth2IdentityBinding