Package software.amazon.awscdk.services.bedrock

Class CfnKnowledgeBase.Builder

java.lang.Object

software.amazon.awscdk.services.bedrock.CfnKnowledgeBase.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnKnowledgeBase>

Enclosing class:

CfnKnowledgeBase

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

A fluent builder for CfnKnowledgeBase.

Method Summary

Modifier and Type	Method	Description
CfnKnowledgeBase	build()
static CfnKnowledgeBase.Builder	create(software.constructs.Construct scope, String id)
CfnKnowledgeBase.Builder	description(String description)	The description of the knowledge base.
CfnKnowledgeBase.Builder	knowledgeBaseConfiguration(IResolvable knowledgeBaseConfiguration)	Contains details about the embeddings configuration of the knowledge base.
CfnKnowledgeBase.Builder	knowledgeBaseConfiguration(CfnKnowledgeBase.KnowledgeBaseConfigurationProperty knowledgeBaseConfiguration)	Contains details about the embeddings configuration of the knowledge base.
CfnKnowledgeBase.Builder	name(String name)	The name of the knowledge base.
CfnKnowledgeBase.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
CfnKnowledgeBase.Builder	storageConfiguration(IResolvable storageConfiguration)	Contains details about the storage configuration of the knowledge base.
CfnKnowledgeBase.Builder	storageConfiguration(CfnKnowledgeBase.StorageConfigurationProperty storageConfiguration)	Contains details about the storage configuration of the knowledge base.
CfnKnowledgeBase.Builder	tags(Map<String,String> tags)	Metadata that you can assign to a resource as key-value pairs.

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 CfnKnowledgeBase.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 CfnKnowledgeBase.Builder.

knowledgeBaseConfiguration

@Stability(Stable)
public CfnKnowledgeBase.Builder knowledgeBaseConfiguration(IResolvable knowledgeBaseConfiguration)

Contains details about the embeddings configuration of the knowledge base.

Parameters:

knowledgeBaseConfiguration - Contains details about the embeddings configuration of the knowledge base. This parameter is required.

Returns:

this

See Also:

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

knowledgeBaseConfiguration

@Stability(Stable)
public CfnKnowledgeBase.Builder knowledgeBaseConfiguration(CfnKnowledgeBase.KnowledgeBaseConfigurationProperty knowledgeBaseConfiguration)

Contains details about the embeddings configuration of the knowledge base.

Parameters:

knowledgeBaseConfiguration - Contains details about the embeddings configuration of the knowledge base. This parameter is required.

Returns:

this

See Also:

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

name

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

The name of the knowledge base.

Parameters:

name - The name of the knowledge base. This parameter is required.

Returns:

this

See Also:

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

roleArn

@Stability(Stable)
public CfnKnowledgeBase.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base. This parameter is required.

Returns:

this

See Also:

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

storageConfiguration

@Stability(Stable)
public CfnKnowledgeBase.Builder storageConfiguration(IResolvable storageConfiguration)

Contains details about the storage configuration of the knowledge base.

Parameters:

storageConfiguration - Contains details about the storage configuration of the knowledge base. This parameter is required.

Returns:

this

See Also:

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

storageConfiguration

@Stability(Stable)
public CfnKnowledgeBase.Builder storageConfiguration(CfnKnowledgeBase.StorageConfigurationProperty storageConfiguration)

Contains details about the storage configuration of the knowledge base.

Parameters:

storageConfiguration - Contains details about the storage configuration of the knowledge base. This parameter is required.

Returns:

this

See Also:

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

description

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

The description of the knowledge base.

Parameters:

description - The description of the knowledge base. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnKnowledgeBase.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-knowledgebase.html#cfn-bedrock-knowledgebase-tags

build

@Stability(Stable)
public CfnKnowledgeBase build()

Specified by:

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

Returns:

a newly built instance of CfnKnowledgeBase.