This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.
AWS::Bedrock::Prompt PromptVariant
Contains details about a variant of the prompt.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "AdditionalModelRequestFields" :Json, "GenAiResource" :PromptGenAiResource, "InferenceConfiguration" :PromptInferenceConfiguration, "Metadata" :[ PromptMetadataEntry, ... ], "ModelId" :String, "Name" :String, "TemplateConfiguration" :PromptTemplateConfiguration, "TemplateType" :String}
YAML
AdditionalModelRequestFields:JsonGenAiResource:PromptGenAiResourceInferenceConfiguration:PromptInferenceConfigurationMetadata:- PromptMetadataEntryModelId:StringName:StringTemplateConfiguration:PromptTemplateConfigurationTemplateType:String
Properties
AdditionalModelRequestFields-
Contains model-specific inference configurations that aren't in the
inferenceConfigurationfield. To see model-specific inference parameters, see Inference request parameters and response fields for foundation models.Required: No
Type: Json
Update requires: No interruption
GenAiResource-
Specifies a generative AI resource with which to use the prompt.
Required: No
Type: PromptGenAiResource
Update requires: No interruption
InferenceConfiguration-
Contains inference configurations for the prompt variant.
Required: No
Type: PromptInferenceConfiguration
Update requires: No interruption
Metadata-
An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.
Required: No
Type: Array of PromptMetadataEntry
Minimum:
0Maximum:
50Update requires: No interruption
ModelId-
The unique identifier of the model or inference profile with which to run inference on the prompt.
Required: No
Type: String
Pattern:
^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$Minimum:
1Maximum:
2048Update requires: No interruption
Name-
The name of the prompt variant.
Required: Yes
Type: String
Pattern:
^([0-9a-zA-Z][_-]?){1,100}$Update requires: No interruption
TemplateConfiguration-
Contains configurations for the prompt template.
Required: Yes
Type: PromptTemplateConfiguration
Update requires: No interruption
TemplateType-
The type of prompt template to use.
Required: Yes
Type: String
Allowed values:
TEXT | CHATUpdate requires: No interruption