AWS::Bedrock::Prompt - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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 Amazon 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

Property description not available.

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

Property description not available.

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

Property description not available.

Required: No

Type: Object of String

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

Minimum: 0

Maximum: 256

Update requires: No interruption

Variants

Property description not available.

Required: No

Type: Array of PromptVariant

Minimum: 0

Maximum: 3

Update requires: No interruption

Return values

Ref

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.