Package software.amazon.awscdk.services.bedrockagentcore

Class ApiKeyCredentialLocation

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.bedrockagentcore.ApiKeyCredentialLocation
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.129.0 (build eaca441)", date="2026-05-19T08:18:44.217Z") @Stability(Stable) public class ApiKeyCredentialLocation extends software.amazon.jsii.JsiiObject
API Key location within the request.

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);

  • Constructor Details

    • ApiKeyCredentialLocation

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

    • ApiKeyCredentialLocation

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

  • Method Details

    • header

      @Stability(Stable) @NotNull public static ApiKeyCredentialLocation header(@Nullable ApiKeyAdditionalConfiguration config)
      Create a header-based API key credential location.

      Parameters:
      config -
      • Optional configuration for the credential location.
      Returns:
      ApiKeyCredentialLocation configured for header placement

    • header

      @Stability(Stable) @NotNull public static ApiKeyCredentialLocation header()
      Create a header-based API key credential location.

      Returns:
      ApiKeyCredentialLocation configured for header placement

    • queryParameter

      @Stability(Stable) @NotNull public static ApiKeyCredentialLocation queryParameter(@Nullable ApiKeyAdditionalConfiguration config)
      Create a query parameter-based API key credential location.

      Parameters:
      config -
      • Optional configuration for the credential location.
      Returns:
      ApiKeyCredentialLocation configured for query parameter placement

    • queryParameter

      @Stability(Stable) @NotNull public static ApiKeyCredentialLocation queryParameter()
      Create a query parameter-based API key credential location.

      Returns:
      ApiKeyCredentialLocation configured for query parameter placement

    • getCredentialLocationType

      @Stability(Stable) @NotNull public String getCredentialLocationType()
      The type of credential location (HEADER or QUERY_PARAMETER).

    • getCredentialParameterName

      @Stability(Stable) @NotNull public String getCredentialParameterName()
      The name of the credential parameter.

    • getCredentialPrefix

      @Stability(Stable) @Nullable public String getCredentialPrefix()
      The prefix for the credential value.