2.248.0

interface CfnPromptMixinProps

LanguageType name
.NETAmazon.CDK.CfnPropertyMixins.AWS.Bedrock.CfnPromptMixinProps
Gogithub.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsbedrock#CfnPromptMixinProps
Javasoftware.amazon.awscdk.cfnpropertymixins.services.bedrock.CfnPromptMixinProps
Pythonaws_cdk.cfn_property_mixins.aws_bedrock.CfnPromptMixinProps
TypeScript @aws-cdk/cfn-property-mixins » aws_bedrock » CfnPromptMixinProps

Properties for CfnPromptPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html

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/cfn-property-mixins';

declare const additionalModelRequestFields: any;
declare const any: any;
declare const auto: any;
declare const json: any;
const cfnPromptMixinProps: bedrock.CfnPromptMixinProps = {
  customerEncryptionKeyArn: 'customerEncryptionKeyArn',
  defaultVariant: 'defaultVariant',
  description: 'description',
  name: 'name',
  tags: {
    tagsKey: 'tags',
  },
  variants: [{
    additionalModelRequestFields: additionalModelRequestFields,
    genAiResource: {
      agent: {
        agentIdentifier: 'agentIdentifier',
      },
    },
    inferenceConfiguration: {
      text: {
        maxTokens: 123,
        stopSequences: ['stopSequences'],
        temperature: 123,
        topP: 123,
      },
    },
    metadata: [{
      key: 'key',
      value: 'value',
    }],
    modelId: 'modelId',
    name: 'name',
    templateConfiguration: {
      chat: {
        inputVariables: [{
          name: 'name',
        }],
        messages: [{
          content: [{
            cachePoint: {
              type: 'type',
            },
            text: 'text',
          }],
          role: 'role',
        }],
        system: [{
          cachePoint: {
            type: 'type',
          },
          text: 'text',
        }],
        toolConfiguration: {
          toolChoice: {
            any: any,
            auto: auto,
            tool: {
              name: 'name',
            },
          },
          tools: [{
            cachePoint: {
              type: 'type',
            },
            toolSpec: {
              description: 'description',
              inputSchema: {
                json: json,
              },
              name: 'name',
            },
          }],
        },
      },
      text: {
        cachePoint: {
          type: 'type',
        },
        inputVariables: [{
          name: 'name',
        }],
        text: 'text',
        textS3Location: {
          bucket: 'bucket',
          key: 'key',
          version: 'version',
        },
      },
    },
    templateType: 'templateType',
  }],
};

Properties

NameTypeDescription
customerEncryptionKeyArn?stringThe Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.
defaultVariant?stringThe name of the default variant for the prompt.
description?stringThe description of the prompt.
name?stringThe name 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.

customerEncryptionKeyArn?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-customerencryptionkeyarn

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-defaultvariant

description?

Type: string (optional)

The description of the prompt.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-description

name?

Type: string (optional)

The name of the prompt.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-name

tags?

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

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-tags

variants?

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

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-variants

← PreviousNext →