Interface CfnPromptProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnPromptProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-25T14:21:11.186Z")
@Stability(Stable)
public interface CfnPromptProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnPrompt
.
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.*; CfnPromptProps cfnPromptProps = CfnPromptProps.builder() .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") .templateType("templateType") // the properties below are optional .inferenceConfiguration(PromptInferenceConfigurationProperty.builder() .text(PromptModelInferenceConfigurationProperty.builder() .maxTokens(123) .stopSequences(List.of("stopSequences")) .temperature(123) .topK(123) .topP(123) .build()) .build()) .modelId("modelId") .templateConfiguration(PromptTemplateConfigurationProperty.builder() .text(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()) .build()) .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnPromptProps
static final class
An implementation forCfnPromptProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnPromptProps.Builder
builder()
default String
The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.default String
The name of the default variant for the prompt.default String
The description of the prompt.getName()
The name of the prompt.getTags()
Metadata that you can assign to a resource as key-value pairs.default Object
A list of objects, each containing details about a variant of the prompt.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getName
The name of the prompt.- See Also:
-
getCustomerEncryptionKeyArn
The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.- See Also:
-
getDefaultVariant
The name of the default variant for the prompt.This value must match the
name
field in the relevant PromptVariant object.- See Also:
-
getDescription
The description of the prompt.- See Also:
-
getTags
Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.- See Also:
-
getVariants
A list of objects, each containing details about a variant of the prompt.- See Also:
-
builder
- Returns:
- a
CfnPromptProps.Builder
ofCfnPromptProps
-