This is the new AWS 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
The API key credential provider for the gateway target.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "CredentialLocation" :
String
, "CredentialParameterName" :String
, "CredentialPrefix" :String
, "ProviderArn" :String
}
YAML
CredentialLocation:
String
CredentialParameterName:String
CredentialPrefix:String
ProviderArn:String
Properties
CredentialLocation
-
The credential location for the gateway target.
Required: No
Type: String
Allowed values:
HEADER | QUERY_PARAMETER
Update requires: No interruption
CredentialParameterName
-
The credential parameter name for the provider for the gateway target.
Required: No
Type: String
Minimum:
1
Maximum:
64
Update requires: No interruption
CredentialPrefix
-
The API key credential provider for the gateway target.
Required: No
Type: String
Minimum:
1
Maximum:
64
Update requires: No interruption
ProviderArn
-
The provider ARN for the gateway target.
Required: Yes
Type: String
Pattern:
^arn:([^:]*):([^:]*):([^:]*):([0-9]{12})?:(.+)$
Update requires: No interruption