Package software.amazon.awscdk.services.bedrock

Interface CfnPrompt.TextPromptTemplateConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPrompt.TextPromptTemplateConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnPrompt

@Stability(Stable)
public static interface CfnPrompt.TextPromptTemplateConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Contains configurations for a text prompt template.

To include a variable, enclose a word in double curly braces as in {{variable}} .

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.*;
 TextPromptTemplateConfigurationProperty textPromptTemplateConfigurationProperty = TextPromptTemplateConfigurationProperty.builder()
         .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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPrompt.TextPromptTemplateConfigurationProperty.Builder	builder()
default Object	getInputVariables()	An array of the variables in the prompt template.
default String	getText()	The message for the prompt.
default Object	getTextS3Location()	The Amazon S3 location of the prompt text.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInputVariables

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

An array of the variables in the prompt template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-textprompttemplateconfiguration.html#cfn-bedrock-prompt-textprompttemplateconfiguration-inputvariables

getText

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

The message for the prompt.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-textprompttemplateconfiguration.html#cfn-bedrock-prompt-textprompttemplateconfiguration-text

getTextS3Location

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

The Amazon S3 location of the prompt text.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-textprompttemplateconfiguration.html#cfn-bedrock-prompt-textprompttemplateconfiguration-texts3location

builder

@Stability(Stable)
static CfnPrompt.TextPromptTemplateConfigurationProperty.Builder builder()

Returns:

a CfnPrompt.TextPromptTemplateConfigurationProperty.Builder of CfnPrompt.TextPromptTemplateConfigurationProperty