Package software.amazon.awscdk.services.bedrock

Class CfnPrompt.Builder

java.lang.Object

software.amazon.awscdk.services.bedrock.CfnPrompt.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPrompt>

Enclosing class:

CfnPrompt

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

A fluent builder for CfnPrompt.

Method Summary

Modifier and Type	Method	Description
CfnPrompt	build()
static CfnPrompt.Builder	create(software.constructs.Construct scope, String id)
CfnPrompt.Builder	customerEncryptionKeyArn(String customerEncryptionKeyArn)	The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.
CfnPrompt.Builder	defaultVariant(String defaultVariant)	The name of the default variant for the prompt.
CfnPrompt.Builder	description(String description)	The description of the prompt.
CfnPrompt.Builder	name(String name)	The name of the prompt.
CfnPrompt.Builder	tags(Map<String,String> tags)	Metadata that you can assign to a resource as key-value pairs.
CfnPrompt.Builder	variants(List<? extends Object> variants)	A list of objects, each containing details about a variant of the prompt.
CfnPrompt.Builder	variants(IResolvable variants)	A list of objects, each containing details about a variant of the prompt.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnPrompt.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnPrompt.Builder.

name

@Stability(Stable)
public CfnPrompt.Builder name(String name)

The name of the prompt.

Parameters:

name - The name of the prompt. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-name

customerEncryptionKeyArn

@Stability(Stable)
public CfnPrompt.Builder customerEncryptionKeyArn(String customerEncryptionKeyArn)

The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.

Parameters:

customerEncryptionKeyArn - The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-customerencryptionkeyarn

defaultVariant

@Stability(Stable)
public CfnPrompt.Builder defaultVariant(String defaultVariant)

The name of the default variant for the prompt.

This value must match the name field in the relevant PromptVariant object.

Parameters:

defaultVariant - The name of the default variant for the prompt. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-defaultvariant

description

@Stability(Stable)
public CfnPrompt.Builder description(String description)

The description of the prompt.

Parameters:

description - The description of the prompt. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-description

tags

@Stability(Stable)
public CfnPrompt.Builder tags(Map<String,String> tags)

Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.

• Tag naming limits and requirements
• Tagging best practices

Parameters:

tags - Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-tags

variants

@Stability(Stable)
public CfnPrompt.Builder variants(IResolvable variants)

A list of objects, each containing details about a variant of the prompt.

Parameters:

variants - A list of objects, each containing details about a variant of the prompt. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-variants

variants

@Stability(Stable)
public CfnPrompt.Builder variants(List<? extends Object> variants)

A list of objects, each containing details about a variant of the prompt.

Parameters:

variants - A list of objects, each containing details about a variant of the prompt. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-variants

build

@Stability(Stable)
public CfnPrompt build()

Specified by:

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

Returns:

a newly built instance of CfnPrompt.