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

Class PromptProps.Builder

java.lang.Object

software.amazon.awscdk.services.bedrock.alpha.PromptProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PromptProps>

Enclosing interface:

PromptProps

@Stability(Experimental)
public static final class PromptProps.Builder
extends Object
implements software.amazon.jsii.Builder<PromptProps>

A builder for PromptProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PromptProps	build()	Builds the configured instance.
PromptProps.Builder	defaultVariant(IPromptVariant defaultVariant)	Sets the value of PromptProps.getDefaultVariant()
PromptProps.Builder	description(String description)	Sets the value of PromptProps.getDescription()
PromptProps.Builder	kmsKey(IKey kmsKey)	Sets the value of PromptProps.getKmsKey()
PromptProps.Builder	promptName(String promptName)	Sets the value of PromptProps.getPromptName()
PromptProps.Builder	tags(Map<String,String> tags)	Sets the value of PromptProps.getTags()
PromptProps.Builder	variants(List<? extends IPromptVariant> variants)	Sets the value of PromptProps.getVariants()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

promptName

@Stability(Experimental)
public PromptProps.Builder promptName(String promptName)

Sets the value of PromptProps.getPromptName()

Parameters:

promptName - The name of the prompt. This parameter is required. This will be used as the physical name of the prompt. Allowed Pattern: ^([0-9a-zA-Z][_-]?){1,100}$

Returns:

this

defaultVariant

@Stability(Experimental)
public PromptProps.Builder defaultVariant(IPromptVariant defaultVariant)

Sets the value of PromptProps.getDefaultVariant()

Parameters:

defaultVariant - The Prompt Variant that will be used by default.

Returns:

this

description

@Stability(Experimental)
public PromptProps.Builder description(String description)

Sets the value of PromptProps.getDescription()

Parameters:

description - A description of what the prompt does.

Returns:

this

kmsKey

@Stability(Experimental)
public PromptProps.Builder kmsKey(IKey kmsKey)

Sets the value of PromptProps.getKmsKey()

Parameters:

kmsKey - The KMS key that the prompt is encrypted with.

Returns:

this

tags

@Stability(Experimental)
public PromptProps.Builder tags(Map<String,String> tags)

Sets the value of PromptProps.getTags()

Parameters:

tags - Tags to apply to the prompt.

Returns:

this

variants

@Stability(Experimental)
public PromptProps.Builder variants(List<? extends IPromptVariant> variants)

Sets the value of PromptProps.getVariants()

Parameters:

variants - The variants of your prompt. Variants can use different messages, models, or configurations so that you can compare their outputs to decide the best variant for your use case. Maximum of 1 variants.

Returns:

this

build

@Stability(Experimental)
public PromptProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<PromptProps>

Returns:

a new instance of PromptProps

Throws:

NullPointerException - if any required attribute was not provided