Creates a static snapshot of your prompt that can be deployed to production. For more information, see Deploy prompts using Prompt management by creating versions in the Amazon Bedrock User Guide.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::Bedrock::PromptVersion",
"Properties" : {
"Description" : String,
"PromptArn" : String,
"Tags" : {Key: Value, ...}
}
}
YAML
Type: AWS::Bedrock::PromptVersion
Properties:
Description: String
PromptArn: String
Tags:
Key: Value
Properties
Description-
The description of the prompt version.
Required: No
Type: String
Minimum:
1Maximum:
200Update requires: Replacement
PromptArn-
The Amazon Resource Name (ARN) of the version of the prompt.
Required: Yes
Type: String
Pattern:
^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})$Minimum:
1Maximum:
2048Update requires: Replacement
-
A map of tags attached to the prompt version and their values.
Required: No
Type: Object of String
Pattern:
^[a-zA-Z0-9\s._:/=+@-]*$Minimum:
0Maximum:
256Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Amazon Resource Number (ARN) of the prompt version.
For example, { "Ref": "myPromptVersion" } could return the value ""arn:aws:bedrock:us-east-1:123456789012:prompt/PROMPT12345:1".
For more information about using the Ref function, see Ref.
Fn::GetAtt
The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.
Arn-
The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
CreatedAt-
The time at which the prompt was created.
CustomerEncryptionKeyArn-
The Amazon Resource Name (ARN) of the KMS key that the prompt version is encrypted with.
DefaultVariant-
The name of the default variant for the prompt. This value must match the
namefield in the relevant PromptVariant object. Name-
The name of the prompt.
PromptId-
The unique identifier of the prompt.
UpdatedAt-
The time at which the prompt was last updated.
Variants-
A list of objects, each containing details about a variant of the prompt.
Version-
The version of the prompt that this summary applies to.
