Experimental
@aws-cdk/aws-bedrock-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
PromptProps Struct
Properties for creating a CDK managed Bedrock Prompt.
Example
ts
const cmk = new kms.Key(this, 'cmk', {});
const claudeModel = bedrock.BedrockFoundationModel.ANTHROPIC_CLAUDE_SONNET_V1_0;
const variant1 = bedrock.PromptVariant.text({
variantName: 'variant1',
model: claudeModel,
promptVariables: ['topic'],
promptText: 'This is my first text prompt. Please summarize our conversation on: {{topic}}.',
inferenceConfiguration: bedrock.PromptInferenceConfiguration.text({
temperature: 1.0,
topP: 0.999,
maxTokens: 2000,
}),
});
const prompt1 = new bedrock.Prompt(this, 'prompt1', {
promptName: 'prompt1',
description: 'my first prompt',
defaultVariant: variant1,
variants: [variant1],
kmsKey: cmk,
});
Properties
defaultVariantoptionalIPromptVariantdefault_variantoptionalIPromptVariantdefaultVariantoptionalIPromptVariantDefaultVariantoptionalIPromptVariantDefaultVariantoptionalIPromptVariant#The Prompt Variant that will be used by default.
Default: No default variant provided.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#A description of what the prompt does.
Default: No description provided. Maximum Length: 200
The KMS key that the prompt is encrypted with.
Default: AWS owned and managed key.
The name of the prompt.
This will be used as the physical name of the prompt. Allowed Pattern: ^([0-9a-zA-Z][_-]?){1,100}$
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#Tags to apply to the prompt.
Default: No tags applied.
variantsoptionalIPromptVariant[]variantsoptionaltyping.List[IPromptVariant]variantsoptionalList<IPromptVariant>VariantsoptionalIPromptVariant[]Variantsoptional*[]IPromptVariant#The variants of your prompt.
Default: No additional variants provided.
Variants can use different messages, models, or configurations so that you can compare their outputs to decide the best variant for your use case. Maximum of 1 variants.