Package software.amazon.awscdk.services.bedrock

Class CfnPrompt

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.bedrock.CfnPrompt

All Implemented Interfaces:

IInspectable, ITaggableV2, IPromptRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:32.463Z")
@Stability(Stable)
public class CfnPrompt
extends CfnResource
implements IInspectable, IPromptRef, ITaggableV2

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.

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;
 CfnPrompt cfnPrompt = CfnPrompt.Builder.create(this, "MyCfnPrompt")
         .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	Class	Description
static final class	CfnPrompt.Builder	A fluent builder for CfnPrompt.
static interface	CfnPrompt.CachePointBlockProperty	Defines a section of content to be cached for reuse in subsequent API calls.
static interface	CfnPrompt.ChatPromptTemplateConfigurationProperty	Contains configurations to use a prompt in a conversational format.
static interface	CfnPrompt.ContentBlockProperty	A block of content for a message that you pass to, or receive from, a model with the Converse or ConverseStream API operations.
static interface	CfnPrompt.MessageProperty	A message input, or returned from, a call to Converse or ConverseStream .
static interface	CfnPrompt.PromptAgentResourceProperty	Contains specifications for an Amazon Bedrock agent with which to use the prompt.
static interface	CfnPrompt.PromptGenAiResourceProperty	Contains specifications for a generative AI resource with which to use the prompt.
static interface	CfnPrompt.PromptInferenceConfigurationProperty	Contains inference configurations for the prompt.
static interface	CfnPrompt.PromptInputVariableProperty	Contains information about a variable in the prompt.
static interface	CfnPrompt.PromptMetadataEntryProperty	Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant.
static interface	CfnPrompt.PromptModelInferenceConfigurationProperty	Contains inference configurations related to model inference for a prompt.
static interface	CfnPrompt.PromptTemplateConfigurationProperty	Contains the message for a prompt.
static interface	CfnPrompt.PromptVariantProperty	Contains details about a variant of the prompt.
static interface	CfnPrompt.SpecificToolChoiceProperty	The model must request a specific tool.
static interface	CfnPrompt.SystemContentBlockProperty	Contains configurations for instructions to provide the model for how to handle input.
static interface	CfnPrompt.TextPromptTemplateConfigurationProperty	Contains configurations for a text prompt template.
static interface	CfnPrompt.TextS3LocationProperty	The Amazon S3 location of the prompt text.
static interface	CfnPrompt.ToolChoiceProperty	Determines which tools the model should request in a call to Converse or ConverseStream .
static interface	CfnPrompt.ToolConfigurationProperty	Configuration information for the tools that you pass to a model.
static interface	CfnPrompt.ToolInputSchemaProperty	The schema for the tool.
static interface	CfnPrompt.ToolProperty	Information about a tool that you can use with the Converse API.
static interface	CfnPrompt.ToolSpecificationProperty	The specification for the tool.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.bedrock.IPromptRef

IPromptRef.Jsii$Default, IPromptRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnPrompt(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPrompt(software.amazon.jsii.JsiiObjectRef objRef)
	CfnPrompt(software.constructs.Construct scope, String id, CfnPromptProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
String	getAttrCreatedAt()	The time at which the prompt was created.
String	getAttrId()	The unique identifier of the prompt.
String	getAttrUpdatedAt()	The time at which the prompt was last updated.
String	getAttrVersion()	The version of the prompt that this summary applies to.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getCustomerEncryptionKeyArn()	The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.
String	getDefaultVariant()	The name of the default variant for the prompt.
String	getDescription()	The description of the prompt.
String	getName()	The name of the prompt.
PromptReference	getPromptRef()	A reference to a Prompt resource.
Map<String,String>	getTags()	Metadata that you can assign to a resource as key-value pairs.
Object	getVariants()	A list of objects, each containing details about a variant of the prompt.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCustomerEncryptionKeyArn(String value)	The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.
void	setDefaultVariant(String value)	The name of the default variant for the prompt.
void	setDescription(String value)	The description of the prompt.
void	setName(String value)	The name of the prompt.
void	setTags(Map<String,String> value)	Metadata that you can assign to a resource as key-value pairs.
void	setVariants(List<Object> value)	A list of objects, each containing details about a variant of the prompt.
void	setVariants(IResolvable value)	A list of objects, each containing details about a variant of the prompt.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnPrompt

protected CfnPrompt(software.amazon.jsii.JsiiObjectRef objRef)

CfnPrompt

protected CfnPrompt(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnPrompt

@Stability(Stable)
public CfnPrompt(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnPromptProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).

getAttrCreatedAt

@Stability(Stable)
@NotNull
public String getAttrCreatedAt()

The time at which the prompt was created.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

The unique identifier of the prompt.

getAttrUpdatedAt

@Stability(Stable)
@NotNull
public String getAttrUpdatedAt()

The time at which the prompt was last updated.

getAttrVersion

@Stability(Stable)
@NotNull
public String getAttrVersion()

The version of the prompt that this summary applies to.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getPromptRef

@Stability(Stable)
@NotNull
public PromptReference getPromptRef()

A reference to a Prompt resource.

Specified by:

getPromptRef in interface IPromptRef

getName

@Stability(Stable)
@NotNull
public String getName()

The name of the prompt.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of the prompt.

getCustomerEncryptionKeyArn

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

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

setCustomerEncryptionKeyArn

@Stability(Stable)
public void setCustomerEncryptionKeyArn(@Nullable
 String value)

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

getDefaultVariant

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

The name of the default variant for the prompt.

setDefaultVariant

@Stability(Stable)
public void setDefaultVariant(@Nullable
 String value)

The name of the default variant for the prompt.

getDescription

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

The description of the prompt.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description of the prompt.

getTags

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

Metadata that you can assign to a resource as key-value pairs.

For more information, see the following resources:.

setTags

@Stability(Stable)
public void setTags(@Nullable
 Map<String,String> value)

Metadata that you can assign to a resource as key-value pairs.

For more information, see the following resources:.

getVariants

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

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPrompt.PromptVariantProperty>

setVariants

@Stability(Stable)
public void setVariants(@Nullable
 IResolvable value)

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

setVariants

@Stability(Stable)
public void setVariants(@Nullable
 List<Object> value)

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