AWS::BedrockAgentCore::GatewayTarget ApiKeyCredentialProvider - AWS CloudFormation
SyntaxProperties

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::BedrockAgentCore::GatewayTarget ApiKeyCredentialProvider

An API key credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using an API key.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "CredentialLocation" : String,
  "CredentialParameterName" : String,
  "CredentialPrefix" : String,
  "ProviderArn" : String
}

Properties

CredentialLocation

The location of the API key credential. This field specifies where in the request the API key should be placed.

Required: No

Type: String

Allowed values: HEADER | QUERY_PARAMETER

Update requires: No interruption

CredentialParameterName

The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.

Required: No

Type: String

Minimum: 1

Maximum: 64

Update requires: No interruption

CredentialPrefix

The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.

Required: No

Type: String

Minimum: 1

Maximum: 64

Update requires: No interruption

ProviderArn

The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in AWS.

Required: Yes

Type: String

Pattern: ^arn:([^:]*):([^:]*):([^:]*):([0-9]{12})?:(.+)$

Update requires: No interruption