Class ApiKeyCredentialLocation

(deprecated) API Key location within the request.

Inheritance

ApiKeyCredentialLocation

Namespace: Amazon.CDK.AWS.Bedrock.Agentcore.Alpha

Assembly: Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.dll

Syntax (csharp)

[Obsolete("Use the equivalent construct from `aws-cdk-lib/aws-bedrockagentcore` instead.")]
public class ApiKeyCredentialLocation : DeputyBase

Syntax (vb)

<Obsolete("Use the equivalent construct from `aws-cdk-lib/aws-bedrockagentcore` instead.")>
Public Class ApiKeyCredentialLocation Inherits DeputyBase

Remarks

Stability: Deprecated

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Bedrock.Agentcore.Alpha;

             var apiKeyCredentialLocation = ApiKeyCredentialLocation.Header(new ApiKeyAdditionalConfiguration {
                 CredentialParameterName = "credentialParameterName",
                 CredentialPrefix = "credentialPrefix"
             });

Synopsis

Properties

CredentialLocationType	(deprecated) The type of credential location (HEADER or QUERY_PARAMETER).
CredentialParameterName	(deprecated) The name of the credential parameter.
CredentialPrefix	(deprecated) The prefix for the credential value.

Methods

Header(IApiKeyAdditionalConfiguration?)	(deprecated) Create a header-based API key credential location.
QueryParameter(IApiKeyAdditionalConfiguration?)	(deprecated) Create a query parameter-based API key credential location.

Properties

CredentialLocationType

(deprecated) The type of credential location (HEADER or QUERY_PARAMETER).

[Obsolete]
public virtual string CredentialLocationType { get; }

Property Value

string

Remarks

Stability: Deprecated

CredentialParameterName

(deprecated) The name of the credential parameter.

[Obsolete]
public virtual string CredentialParameterName { get; }

Property Value

string

Remarks

Stability: Deprecated

CredentialPrefix

(deprecated) The prefix for the credential value.

[Obsolete]
public virtual string? CredentialPrefix { get; }

Property Value

string

Remarks

Stability: Deprecated

Methods

Header(IApiKeyAdditionalConfiguration?)

(deprecated) Create a header-based API key credential location.

[Obsolete]
public static ApiKeyCredentialLocation Header(IApiKeyAdditionalConfiguration? config = null)

Parameters

config IApiKeyAdditionalConfiguration

Optional configuration for the credential location.

Returns

ApiKeyCredentialLocation

ApiKeyCredentialLocation configured for header placement

Remarks

Stability: Deprecated

QueryParameter(IApiKeyAdditionalConfiguration?)

(deprecated) Create a query parameter-based API key credential location.

[Obsolete]
public static ApiKeyCredentialLocation QueryParameter(IApiKeyAdditionalConfiguration? config = null)

Parameters

config IApiKeyAdditionalConfiguration

Optional configuration for the credential location.

Returns

ApiKeyCredentialLocation

ApiKeyCredentialLocation configured for query parameter placement

Remarks

Stability: Deprecated