Package software.amazon.awscdk.services.bedrock.alpha

Interface CommonPromptVariantProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AgentPromptVariantProps, ChatPromptVariantProps, TextPromptVariantProps

All Known Implementing Classes:

AgentPromptVariantProps.Jsii$Proxy, ChatPromptVariantProps.Jsii$Proxy, CommonPromptVariantProps.Jsii$Proxy, TextPromptVariantProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-07-29T17:51:11.491Z")
@Stability(Experimental)
public interface CommonPromptVariantProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Common properties for all prompt variants.

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.alpha.*;
 IBedrockInvokable bedrockInvokable;
 CommonPromptVariantProps commonPromptVariantProps = CommonPromptVariantProps.builder()
         .model(bedrockInvokable)
         .variantName("variantName")
         // the properties below are optional
         .promptVariables(List.of("promptVariables"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CommonPromptVariantProps.Builder	builder()
IBedrockInvokable	getModel()	(experimental) The model which is used to run the prompt.
default List<String>	getPromptVariables()	(experimental) The variables in the prompt template that can be filled in at runtime.
String	getVariantName()	(experimental) The name of the prompt variant.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getModel

@Stability(Experimental)
@NotNull
IBedrockInvokable getModel()

(experimental) The model which is used to run the prompt.

The model could be a foundation model, a custom model, or a provisioned model.

getVariantName

@Stability(Experimental)
@NotNull
String getVariantName()

(experimental) The name of the prompt variant.

getPromptVariables

@Stability(Experimental)
@Nullable
default List<String> getPromptVariables()

(experimental) The variables in the prompt template that can be filled in at runtime.

Default: - No variables defined.

builder

@Stability(Experimental)
static CommonPromptVariantProps.Builder builder()

Returns:

a CommonPromptVariantProps.Builder of CommonPromptVariantProps