Class CfnPromptVersion
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.CfnPromptVersion
- All Implemented Interfaces:
IInspectable,IPromptVersionRef,IEnvironmentAware,ITaggableV2,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
date="2025-12-05T22:26:30.853Z")
@Stability(Stable)
public class CfnPromptVersion
extends CfnResource
implements IInspectable, IPromptVersionRef, ITaggableV2
Creates a static snapshot of your prompt that can be deployed to production.
For more information, see Deploy prompts using Prompt management by creating versions 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.*;
CfnPromptVersion cfnPromptVersion = CfnPromptVersion.Builder.create(this, "MyCfnPromptVersion")
.promptArn("promptArn")
// the properties below are optional
.description("description")
.tags(Map.of(
"tagsKey", "tags"))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA fluent builder forCfnPromptVersion.static interfaceDefines a section of content to be cached for reuse in subsequent API calls.static interfaceContains configurations to use a prompt in a conversational format.static interfaceA block of content for a message that you pass to, or receive from, a model with the Converse or ConverseStream API operations.static interfaceA message input, or returned from, a call to Converse or ConverseStream .static interfaceContains specifications for an Amazon Bedrock agent with which to use the prompt.static interfaceContains specifications for a generative AI resource with which to use the prompt.static interfaceContains inference configurations for the prompt.static interfaceContains information about a variable in the prompt.static interfaceContains a key-value pair that defines a metadata tag and value to attach to a prompt variant.static interfaceContains inference configurations related to model inference for a prompt.static interfaceContains the message for a prompt.static interfaceContains details about a variant of the prompt.static interfaceThe model must request a specific tool.static interfaceContains configurations for instructions to provide the model for how to handle input.static interfaceContains configurations for a text prompt template.static interfaceDetermines which tools the model should request in a call toConverseorConverseStream.static interfaceConfiguration information for the tools that you pass to a model.static interfaceThe schema for the tool.static interfaceInformation about a tool that you can use with the Converse API.static interfaceThe specification for the tool.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.bedrock.IPromptVersionRef
IPromptVersionRef.Jsii$Default, IPromptVersionRef.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnPromptVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnPromptVersion(software.amazon.jsii.JsiiObjectRef objRef) CfnPromptVersion(software.constructs.Construct scope, String id, CfnPromptVersionProps props) Create a newAWS::Bedrock::PromptVersion. -
Method Summary
Modifier and TypeMethodDescriptionstatic StringarnForPromptVersion(IPromptVersionRef resource) The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).The time at which the prompt was created.The Amazon Resource Name (ARN) of the KMS key that the prompt version is encrypted with.The name of the default variant for the prompt.The name of the prompt.The unique identifier of the prompt.The time at which the prompt was last updated.A list of objects, each containing details about a variant of the prompt.The version of the prompt that this summary applies to.Tag Manager which manages the tags for this resource.The description of the prompt version.The Amazon Resource Name (ARN) of the version of the prompt.A reference to a PromptVersion resource.getTags()A map of tags attached to the prompt version and their values.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.static BooleanChecks whether the given object is a CfnPromptVersion.renderProperties(Map<String, Object> props) voidsetDescription(String value) The description of the prompt version.voidsetPromptArn(String value) The Amazon Resource Name (ARN) of the version of the prompt.voidA map of tags attached to the prompt version and their values.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware
getEnvMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnPromptVersion
protected CfnPromptVersion(software.amazon.jsii.JsiiObjectRef objRef) -
CfnPromptVersion
protected CfnPromptVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnPromptVersion
@Stability(Stable) public CfnPromptVersion(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPromptVersionProps props) Create a newAWS::Bedrock::PromptVersion.- 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
-
arnForPromptVersion
@Stability(Stable) @NotNull public static String arnForPromptVersion(@NotNull IPromptVersionRef resource) - Parameters:
resource- This parameter is required.
-
isCfnPromptVersion
Checks whether the given object is a CfnPromptVersion.- Parameters:
x- This parameter is required.
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- 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:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request). -
getAttrCreatedAt
The time at which the prompt was created. -
getAttrCustomerEncryptionKeyArn
The Amazon Resource Name (ARN) of the KMS key that the prompt version is encrypted with. -
getAttrDefaultVariant
The name of the default variant for the prompt.This value must match the
namefield in the relevant PromptVariant object. -
getAttrName
The name of the prompt. -
getAttrPromptId
The unique identifier of the prompt. -
getAttrUpdatedAt
The time at which the prompt was last updated. -
getAttrVariants
A list of objects, each containing details about a variant of the prompt. -
getAttrVersion
The version of the prompt that this summary applies to. -
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManagerin interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getPromptVersionRef
A reference to a PromptVersion resource.- Specified by:
getPromptVersionRefin interfaceIPromptVersionRef
-
getPromptArn
The Amazon Resource Name (ARN) of the version of the prompt. -
setPromptArn
The Amazon Resource Name (ARN) of the version of the prompt. -
getDescription
The description of the prompt version. -
setDescription
The description of the prompt version. -
getTags
A map of tags attached to the prompt version and their values. -
setTags
A map of tags attached to the prompt version and their values.
-