interface CfnPromptProps

Language	Type name
.NET	`Amazon.CDK.aws_bedrock.CfnPromptProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsbedrock#CfnPromptProps`
Java	`software.amazon.awscdk.services.bedrock.CfnPromptProps`
Python	`aws_cdk.aws_bedrock.CfnPromptProps`
TypeScript	`aws-cdk-lib` » `aws_bedrock` » `CfnPromptProps`

Properties for defining a CfnPrompt.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';
const cfnPromptProps: bedrock.CfnPromptProps = {
  name: 'name',

  // the properties below are optional
  customerEncryptionKeyArn: 'customerEncryptionKeyArn',
  defaultVariant: 'defaultVariant',
  description: 'description',
  tags: {
    tagsKey: 'tags',
  },
  variants: [{
    name: 'name',
    templateConfiguration: {
      text: {
        inputVariables: [{
          name: 'name',
        }],
        text: 'text',
        textS3Location: {
          bucket: 'bucket',
          key: 'key',

          // the properties below are optional
          version: 'version',
        },
      },
    },
    templateType: 'templateType',

    // the properties below are optional
    inferenceConfiguration: {
      text: {
        maxTokens: 123,
        stopSequences: ['stopSequences'],
        temperature: 123,
        topP: 123,
      },
    },
    modelId: 'modelId',
  }],
};

Properties

Name	Type	Description
name	`string`	The name of the prompt.
customerEncryptionKeyArn?	`string`	The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.
defaultVariant?	`string`	The name of the default variant for the prompt.
description?	`string`	The description of the prompt.
tags?	`{ [string]: string }`	Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.
variants?	`IResolvable` `\|` `IResolvable` `\|` `PromptVariantProperty[]`	A list of objects, each containing details about a variant of the prompt.

name

Type: string

The name of the prompt.

customerEncryptionKeyArn?

Type: string (optional)

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

defaultVariant?

Type: string (optional)

The name of the default variant for the prompt.

This value must match the name field in the relevant PromptVariant object.

description?

Type: string (optional)

The description of the prompt.

tags?

Type: { [string]: string } (optional)

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

variants?

Type: IResolvable | IResolvable | PromptVariantProperty[] (optional)

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