FromApiKeyIdentityOptions

class aws_cdk.aws_bedrock_agentcore_alpha.FromApiKeyIdentityOptions(*, credential_location=None)

Bases: object

(experimental) Optional gateway settings when binding an {@link IApiKeyCredentialProvider} to a target.

Parameters:

credential_location (Optional[ApiKeyCredentialLocation]) – (experimental) Where to place the API key on outbound requests. Default: header Authorization with ``Bearer `` prefix

Stability:

experimental

ExampleMetadata:

infused

Example:

gateway = agentcore.Gateway(self, "MyGateway",
    gateway_name="my-gateway"
)

# Create an API key credential provider in Token Vault
api_key_provider = agentcore.ApiKeyCredentialProvider(self, "MyApiKeyProvider",
    api_key_credential_provider_name="my-apikey"
)

bucket = s3.Bucket.from_bucket_name(self, "ExistingBucket", "my-schema-bucket")
s3my_schema = agentcore.ApiSchema.from_s3_file(bucket, "schemas/myschema.yaml")

# Add an OpenAPI target using the L2 construct directly
target = gateway.add_open_api_target("MyTarget",
    gateway_target_name="my-api-target",
    description="Target for external API integration",
    api_schema=s3my_schema,
    credential_provider_configurations=[
        agentcore.GatewayCredentialProvider.from_api_key_identity(api_key_provider,
            credential_location=agentcore.ApiKeyCredentialLocation.header(
                credential_parameter_name="X-API-Key"
            )
        )
    ]
)

# This makes sure your s3 bucket is available before target
target.node.add_dependency(bucket)

Attributes

credential_location

(experimental) Where to place the API key on outbound requests.

Default:

header Authorization with ``Bearer `` prefix

Stability:

experimental