interface ApiKeyCredentialProviderProperty

Language	Type name
.NET	Amazon.CDK.aws_bedrockagentcore.CfnGatewayTarget.ApiKeyCredentialProviderProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbedrockagentcore#CfnGatewayTarget_ApiKeyCredentialProviderProperty
Java	software.amazon.awscdk.services.bedrockagentcore.CfnGatewayTarget.ApiKeyCredentialProviderProperty
Python	aws_cdk.aws_bedrockagentcore.CfnGatewayTarget.ApiKeyCredentialProviderProperty
TypeScript	aws-cdk-lib » aws_bedrockagentcore » CfnGatewayTarget » ApiKeyCredentialProviderProperty

The API key credential provider for the gateway target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrockagentcore as bedrockagentcore } from 'aws-cdk-lib';
const apiKeyCredentialProviderProperty: bedrockagentcore.CfnGatewayTarget.ApiKeyCredentialProviderProperty = {
  providerArn: 'providerArn',

  // the properties below are optional
  credentialLocation: 'credentialLocation',
  credentialParameterName: 'credentialParameterName',
  credentialPrefix: 'credentialPrefix',
};

Properties

Name	Type	Description
providerArn	string	The provider ARN for the gateway target.
credentialLocation?	string	The credential location for the gateway target.
credentialParameterName?	string	The credential parameter name for the provider for the gateway target.
credentialPrefix?	string	The API key credential provider for the gateway target.

---

providerArn

Type: string

The provider ARN for the gateway target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-providerarn

---

credentialLocation?

Type: string (optional)

The credential location for the gateway target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentiallocation

---

credentialParameterName?

Type: string (optional)

The credential parameter name for the provider for the gateway target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialparametername

---

credentialPrefix?

Type: string (optional)

The API key credential provider for the gateway target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialprefix