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

Interface ChatTemplateConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ChatTemplateConfigurationProps.Jsii$Proxy

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

(experimental) Properties for creating a chat template configuration.

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.*;
 ChatMessage chatMessage;
 Tool tool;
 ToolChoice toolChoice;
 ChatTemplateConfigurationProps chatTemplateConfigurationProps = ChatTemplateConfigurationProps.builder()
         .messages(List.of(chatMessage))
         // the properties below are optional
         .inputVariables(List.of("inputVariables"))
         .system("system")
         .toolConfiguration(ToolConfiguration.builder()
                 .toolChoice(toolChoice)
                 .tools(List.of(tool))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ChatTemplateConfigurationProps.Builder	builder()
default List<String>	getInputVariables()	(experimental) The input variables for the template.
List<ChatMessage>	getMessages()	(experimental) The messages in the chat template.
default String	getSystem()	(experimental) The system message for the chat template.
default ToolConfiguration	getToolConfiguration()	(experimental) The tool configuration for the chat template.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMessages

@Stability(Experimental)
@NotNull
List<ChatMessage> getMessages()

(experimental) The messages in the chat template.

getInputVariables

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

(experimental) The input variables for the template.

Default: - No input variables

getSystem

@Stability(Experimental)
@Nullable
default String getSystem()

(experimental) The system message for the chat template.

Default: - No system message

getToolConfiguration

@Stability(Experimental)
@Nullable
default ToolConfiguration getToolConfiguration()

(experimental) The tool configuration for the chat template.

Default: - No tool configuration

builder

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

Returns:

a ChatTemplateConfigurationProps.Builder of ChatTemplateConfigurationProps