Package software.amazon.awscdk.services.bedrock

Interface CfnPromptProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPromptProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-14T03:24:54.374Z")
@Stability(Stable)
public interface CfnPromptProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.bedrock.*;
 Object additionalModelRequestFields;
 Object any;
 Object auto;
 Object json;
 CfnPromptProps cfnPromptProps = CfnPromptProps.builder()
         .name("name")
         // the properties below are optional
         .customerEncryptionKeyArn("customerEncryptionKeyArn")
         .defaultVariant("defaultVariant")
         .description("description")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .variants(List.of(PromptVariantProperty.builder()
                 .name("name")
                 .templateConfiguration(PromptTemplateConfigurationProperty.builder()
                         .chat(ChatPromptTemplateConfigurationProperty.builder()
                                 .messages(List.of(MessageProperty.builder()
                                         .content(List.of(ContentBlockProperty.builder()
                                                 .cachePoint(CachePointBlockProperty.builder()
                                                         .type("type")
                                                         .build())
                                                 .text("text")
                                                 .build()))
                                         .role("role")
                                         .build()))
                                 // the properties below are optional
                                 .inputVariables(List.of(PromptInputVariableProperty.builder()
                                         .name("name")
                                         .build()))
                                 .system(List.of(SystemContentBlockProperty.builder()
                                         .cachePoint(CachePointBlockProperty.builder()
                                                 .type("type")
                                                 .build())
                                         .text("text")
                                         .build()))
                                 .toolConfiguration(ToolConfigurationProperty.builder()
                                         .tools(List.of(ToolProperty.builder()
                                                 .cachePoint(CachePointBlockProperty.builder()
                                                         .type("type")
                                                         .build())
                                                 .toolSpec(ToolSpecificationProperty.builder()
                                                         .inputSchema(ToolInputSchemaProperty.builder()
                                                                 .json(json)
                                                                 .build())
                                                         .name("name")
                                                         // the properties below are optional
                                                         .description("description")
                                                         .build())
                                                 .build()))
                                         // the properties below are optional
                                         .toolChoice(ToolChoiceProperty.builder()
                                                 .any(any)
                                                 .auto(auto)
                                                 .tool(SpecificToolChoiceProperty.builder()
                                                         .name("name")
                                                         .build())
                                                 .build())
                                         .build())
                                 .build())
                         .text(TextPromptTemplateConfigurationProperty.builder()
                                 .cachePoint(CachePointBlockProperty.builder()
                                         .type("type")
                                         .build())
                                 .inputVariables(List.of(PromptInputVariableProperty.builder()
                                         .name("name")
                                         .build()))
                                 .text("text")
                                 .textS3Location(TextS3LocationProperty.builder()
                                         .bucket("bucket")
                                         .key("key")
                                         // the properties below are optional
                                         .version("version")
                                         .build())
                                 .build())
                         .build())
                 .templateType("templateType")
                 // the properties below are optional
                 .additionalModelRequestFields(additionalModelRequestFields)
                 .genAiResource(PromptGenAiResourceProperty.builder()
                         .agent(PromptAgentResourceProperty.builder()
                                 .agentIdentifier("agentIdentifier")
                                 .build())
                         .build())
                 .inferenceConfiguration(PromptInferenceConfigurationProperty.builder()
                         .text(PromptModelInferenceConfigurationProperty.builder()
                                 .maxTokens(123)
                                 .stopSequences(List.of("stopSequences"))
                                 .temperature(123)
                                 .topP(123)
                                 .build())
                         .build())
                 .metadata(List.of(PromptMetadataEntryProperty.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .modelId("modelId")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPromptProps.Builder	A builder for CfnPromptProps
static final class	CfnPromptProps.Jsii$Proxy	An implementation for CfnPromptProps

Method Summary

Modifier and Type	Method	Description
static CfnPromptProps.Builder	builder()
default String	getCustomerEncryptionKeyArn()	The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.
default String	getDefaultVariant()	The name of the default variant for the prompt.
default String	getDescription()	The description of the prompt.
String	getName()	The name of the prompt.
default Map<String,String>	getTags()	Metadata that you can assign to a resource as key-value pairs.
default Object	getVariants()	A list of objects, each containing details about a variant of the prompt.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the prompt.

See Also:

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

getCustomerEncryptionKeyArn

@Stability(Stable)
@Nullable
default String getCustomerEncryptionKeyArn()

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

getDefaultVariant

@Stability(Stable)
@Nullable
default String getDefaultVariant()

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the prompt.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

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

• Tag naming limits and requirements
• Tagging best practices

See Also:

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

getVariants

@Stability(Stable)
@Nullable
default Object getVariants()

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

builder

@Stability(Stable)
static CfnPromptProps.Builder builder()

Returns:

a CfnPromptProps.Builder of CfnPromptProps