class ApiKeyCredentialLocation 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.ApiKeyCredentialLocation`
Go	`github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#ApiKeyCredentialLocation`
Java	`software.amazon.awscdk.services.bedrock.agentcore.alpha.ApiKeyCredentialLocation`
Python	`aws_cdk.aws_bedrock_agentcore_alpha.ApiKeyCredentialLocation`
TypeScript (source)	`@aws-cdk/aws-bedrock-agentcore-alpha` » `ApiKeyCredentialLocation`

API Key location within the request.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';
const apiKeyCredentialLocation = bedrock_agentcore_alpha.ApiKeyCredentialLocation.header(/* all optional props */ {
  credentialParameterName: 'credentialParameterName',
  credentialPrefix: 'credentialPrefix',
});

Properties

Name	Type	Description
credentialLocationType🔹	`string`	The type of credential location (HEADER or QUERY_PARAMETER).
credentialParameterName🔹	`string`	The name of the credential parameter.
credentialPrefix?🔹	`string`	The prefix for the credential value.

credentialLocationType🔹

Type: string

The type of credential location (HEADER or QUERY_PARAMETER).

credentialParameterName🔹

Type: string

The name of the credential parameter.

credentialPrefix?🔹

Type: string (optional)

The prefix for the credential value.

Methods

Name	Description
static header(config?)🔹	Create a header-based API key credential location.
static queryParameter(config?)🔹	Create a query parameter-based API key credential location.

static header(config?)🔹

public static header(config?: ApiKeyAdditionalConfiguration): ApiKeyCredentialLocation

Parameters

config ApiKeyAdditionalConfiguration — - Optional configuration for the credential location.

Returns

ApiKeyCredentialLocation

Create a header-based API key credential location.

static queryParameter(config?)🔹

public static queryParameter(config?: ApiKeyAdditionalConfiguration): ApiKeyCredentialLocation