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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Bedrock::Prompt PromptVariant
<a name="aws-properties-bedrock-prompt-promptvariant"></a>

Contains details about a variant of the prompt.

## Syntax
<a name="aws-properties-bedrock-prompt-promptvariant-syntax"></a>

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

### JSON
<a name="aws-properties-bedrock-prompt-promptvariant-syntax.json"></a>

```
{
  "[AdditionalModelRequestFields](#cfn-bedrock-prompt-promptvariant-additionalmodelrequestfields)" : {{Json}},
  "[GenAiResource](#cfn-bedrock-prompt-promptvariant-genairesource)" : {{PromptGenAiResource}},
  "[InferenceConfiguration](#cfn-bedrock-prompt-promptvariant-inferenceconfiguration)" : {{PromptInferenceConfiguration}},
  "[Metadata](#cfn-bedrock-prompt-promptvariant-metadata)" : {{[ PromptMetadataEntry, ... ]}},
  "[ModelId](#cfn-bedrock-prompt-promptvariant-modelid)" : {{String}},
  "[Name](#cfn-bedrock-prompt-promptvariant-name)" : {{String}},
  "[TemplateConfiguration](#cfn-bedrock-prompt-promptvariant-templateconfiguration)" : {{PromptTemplateConfiguration}},
  "[TemplateType](#cfn-bedrock-prompt-promptvariant-templatetype)" : {{String}}
}
```

### YAML
<a name="aws-properties-bedrock-prompt-promptvariant-syntax.yaml"></a>

```
  [AdditionalModelRequestFields](#cfn-bedrock-prompt-promptvariant-additionalmodelrequestfields): {{Json}}
  [GenAiResource](#cfn-bedrock-prompt-promptvariant-genairesource): {{
    PromptGenAiResource}}
  [InferenceConfiguration](#cfn-bedrock-prompt-promptvariant-inferenceconfiguration): {{
    PromptInferenceConfiguration}}
  [Metadata](#cfn-bedrock-prompt-promptvariant-metadata): {{
    - PromptMetadataEntry}}
  [ModelId](#cfn-bedrock-prompt-promptvariant-modelid): {{String}}
  [Name](#cfn-bedrock-prompt-promptvariant-name): {{String}}
  [TemplateConfiguration](#cfn-bedrock-prompt-promptvariant-templateconfiguration): {{
    PromptTemplateConfiguration}}
  [TemplateType](#cfn-bedrock-prompt-promptvariant-templatetype): {{String}}
```

## Properties
<a name="aws-properties-bedrock-prompt-promptvariant-properties"></a>

`AdditionalModelRequestFields`  <a name="cfn-bedrock-prompt-promptvariant-additionalmodelrequestfields"></a>
Contains model-specific inference configurations that aren't in the `inferenceConfiguration` field. To see model-specific inference parameters, see [Inference request parameters and response fields for foundation models](https://docs.amazonaws.cn/bedrock/latest/userguide/model-parameters.html).  
*Required*: No  
*Type*: Json  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GenAiResource`  <a name="cfn-bedrock-prompt-promptvariant-genairesource"></a>
Specifies a generative AI resource with which to use the prompt.  
*Required*: No  
*Type*: [PromptGenAiResource](aws-properties-bedrock-prompt-promptgenairesource.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InferenceConfiguration`  <a name="cfn-bedrock-prompt-promptvariant-inferenceconfiguration"></a>
Contains inference configurations for the prompt variant.  
*Required*: No  
*Type*: [PromptInferenceConfiguration](aws-properties-bedrock-prompt-promptinferenceconfiguration.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Metadata`  <a name="cfn-bedrock-prompt-promptvariant-metadata"></a>
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](aws-properties-bedrock-prompt-promptmetadataentry.md)  
*Minimum*: `0`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelId`  <a name="cfn-bedrock-prompt-promptvariant-modelid"></a>
The unique identifier of the model or [inference profile](https://docs.amazonaws.cn/bedrock/latest/userguide/cross-region-inference.html) 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*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-bedrock-prompt-promptvariant-name"></a>
The name of the prompt variant.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TemplateConfiguration`  <a name="cfn-bedrock-prompt-promptvariant-templateconfiguration"></a>
Contains configurations for the prompt template.  
*Required*: Yes  
*Type*: [PromptTemplateConfiguration](aws-properties-bedrock-prompt-prompttemplateconfiguration.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TemplateType`  <a name="cfn-bedrock-prompt-promptvariant-templatetype"></a>
The type of prompt template to use.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `TEXT | CHAT`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)