AWS::Bedrock::Prompt - AWS CloudFormation
SyntaxPropertiesReturn values

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::Bedrock::Prompt

Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock, Create a prompt using Prompt management and Prompt flows in Amazon Bedrock in the Amazon Bedrock User Guide.

Syntax

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

JSON

{
  "Type" : "AWS::Bedrock::Prompt",
  "Properties" : {
      "CustomerEncryptionKeyArn" : String,
      "DefaultVariant" : String,
      "Description" : String,
      "Name" : String,
      "Tags" : {Key: Value, ...},
      "Variants" : [ PromptVariant, ... ]
    }
}

YAML

Type: AWS::Bedrock::Prompt
Properties:
  CustomerEncryptionKeyArn: String
  DefaultVariant: String
  Description: String
  Name: String
  Tags: 
    Key: Value
  Variants: 
    - PromptVariant

Properties

CustomerEncryptionKeyArn

The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.

Required: No

Type: String

Pattern: ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$

Minimum: 1

Maximum: 2048

Update requires: No interruption

DefaultVariant

The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.

Required: No

Type: String

Pattern: ^([0-9a-zA-Z][_-]?){1,100}$

Update requires: No interruption

Description

The description of the prompt.

Required: No

Type: String

Minimum: 1

Maximum: 200

Update requires: No interruption

Name

The name of the prompt.

Required: Yes

Type: String

Pattern: ^([0-9a-zA-Z][_-]?){1,100}$

Update requires: No interruption

Tags

Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

Required: No

Type: Object of String

Pattern: ^[a-zA-Z0-9\s._:/=+@-]*$

Minimum: 0

Maximum: 256

Update requires: No interruption

Variants

A list of objects, each containing details about a variant of the prompt.

Required: No

Type: Array of PromptVariant

Minimum: 0

Maximum: 1

Update requires: No interruption

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.

For example, { "Ref": "myPrompt" } could return the value "arn:aws:bedrock:us-east-1:123456789012:prompt/PROMPT12345".

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.

Id

The unique identifier of the prompt.

UpdatedAt

The time at which the prompt was last updated.

Version

The version of the prompt that this summary applies to.