View a markdown version of this page

AWS::BedrockAgentCore::Harness HarnessOpenAiModelConfig - 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::Harness HarnessOpenAiModelConfig

Configuration for an OpenAI model provider. Requires an API key stored in AgentCore Identity.

Syntax

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

JSON

{
  "AdditionalParams" : {Key: Value, ...},
  "ApiFormat" : String,
  "ApiKeyArn" : String,
  "MaxTokens" : Integer,
  "ModelId" : String,
  "Temperature" : Number,
  "TopP" : Number
}

YAML

  AdditionalParams: 
    Key: Value
  ApiFormat: String
  ApiKeyArn: String
  MaxTokens: Integer
  ModelId: String
  Temperature: Number
  TopP: Number

Properties

AdditionalParams

Provider-specific parameters passed through to the model provider unchanged.

Required: No

Type: Object

Update requires: No interruption

ApiFormat

The API format to use when calling the OpenAI provider.

Required: No

Type: String

Allowed values: chat_completions | responses

Update requires: No interruption

ApiKeyArn

The ARN of your OpenAI API key on AgentCore Identity.

Required: Yes

Type: String

Pattern: ^arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/apikeycredentialprovider/[a-zA-Z0-9-.]+$

Update requires: No interruption

MaxTokens

The maximum number of tokens to allow in the generated response per model call.

Required: No

Type: Integer

Minimum: 1

Update requires: No interruption

ModelId

The OpenAI model ID.

Required: Yes

Type: String

Update requires: No interruption

Temperature

The temperature to set when calling the model.

Required: No

Type: Number

Minimum: 0

Maximum: 2

Update requires: No interruption

TopP

The topP set when calling the model.

Required: No

Type: Number

Minimum: 0

Maximum: 1

Update requires: No interruption