Package software.amazon.awscdk.services.bedrockagentcore

Interface ApiKeyAdditionalConfiguration

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApiKeyAdditionalConfiguration.Jsii$Proxy

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

API Key additional configuration.

Example:

 Gateway gateway = Gateway.Builder.create(this, "MyGateway")
         .gatewayName("my-gateway")
         .build();
 // Create an API key credential provider in Token Vault
 ApiKeyCredentialProvider apiKeyProvider = ApiKeyCredentialProvider.Builder.create(this, "MyApiKeyProvider")
         .apiKeyCredentialProviderName("my-apikey")
         .build();
 IBucket bucket = Bucket.fromBucketName(this, "ExistingBucket", "my-schema-bucket");
 S3ApiSchema s3mySchema = ApiSchema.fromS3File(bucket, "schemas/myschema.yaml");
 // Add an OpenAPI target using the L2 construct directly
 GatewayTarget target = gateway.addOpenApiTarget("MyTarget", AddOpenApiTargetOptions.builder()
         .gatewayTargetName("my-api-target")
         .description("Target for external API integration")
         .apiSchema(s3mySchema)
         .credentialProviderConfigurations(List.of(GatewayCredentialProvider.fromApiKeyIdentity(apiKeyProvider, FromApiKeyIdentityOptions.builder()
                 .credentialLocation(ApiKeyCredentialLocation.header(ApiKeyAdditionalConfiguration.builder()
                         .credentialParameterName("X-API-Key")
                         .build()))
                 .build())))
         .build());
 // This makes sure your s3 bucket is available before target
 target.node.addDependency(bucket);
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ApiKeyAdditionalConfiguration.Builder	builder()
default String	getCredentialParameterName()	The name of the credential parameter for the API key.
default String	getCredentialPrefix()	The prefix for the API key credential.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCredentialParameterName

@Stability(Stable)
@Nullable
default String getCredentialParameterName()

The name of the credential parameter for the API key.

This parameter name is used when sending the API key to the target endpoint.

Length Constraints: Minimum length of 1. Maximum length of 64.

Default: - 'Authorization' for HEADER, 'api_key' for QUERY_PARAMETER

getCredentialPrefix

@Stability(Stable)
@Nullable
default String getCredentialPrefix()

The prefix for the API key credential.

This prefix is added to the API key when sending it to the target endpoint.

Length Constraints: Minimum length of 1. Maximum length of 64.

Default: - 'Bearer ' for HEADER, no prefix for QUERY_PARAMETER

builder

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

Returns:

a ApiKeyAdditionalConfiguration.Builder of ApiKeyAdditionalConfiguration