Package software.amazon.awscdk.cfnpropertymixins.services.bedrock

Class CfnKnowledgeBasePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.bedrock.CfnKnowledgeBasePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnKnowledgeBasePropsMixin>

Enclosing class:

CfnKnowledgeBasePropsMixin

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

A fluent builder for CfnKnowledgeBasePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnKnowledgeBasePropsMixin	build()
static CfnKnowledgeBasePropsMixin.Builder	create()
static CfnKnowledgeBasePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnKnowledgeBasePropsMixin.Builder	description(String description)	The description of the knowledge base associated with the inline agent.
CfnKnowledgeBasePropsMixin.Builder	knowledgeBaseConfiguration(CfnKnowledgeBasePropsMixin.KnowledgeBaseConfigurationProperty knowledgeBaseConfiguration)	Contains details about the embeddings configuration of the knowledge base.
CfnKnowledgeBasePropsMixin.Builder	knowledgeBaseConfiguration(IResolvable knowledgeBaseConfiguration)	Contains details about the embeddings configuration of the knowledge base.
CfnKnowledgeBasePropsMixin.Builder	name(String name)	The name of the knowledge base.
CfnKnowledgeBasePropsMixin.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
CfnKnowledgeBasePropsMixin.Builder	storageConfiguration(CfnKnowledgeBasePropsMixin.StorageConfigurationProperty storageConfiguration)	Contains details about the storage configuration of the knowledge base.
CfnKnowledgeBasePropsMixin.Builder	storageConfiguration(IResolvable storageConfiguration)	Contains details about the storage configuration of the knowledge base.
CfnKnowledgeBasePropsMixin.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 CfnKnowledgeBasePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnKnowledgeBasePropsMixin.Builder.

create

@Stability(Stable)
public static CfnKnowledgeBasePropsMixin.Builder create()

Returns:

a new instance of CfnKnowledgeBasePropsMixin.Builder.

description

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

The description of the knowledge base associated with the inline agent.

Parameters:

description - The description of the knowledge base associated with the inline agent. 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

knowledgeBaseConfiguration

@Stability(Stable)
public CfnKnowledgeBasePropsMixin.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 CfnKnowledgeBasePropsMixin.Builder knowledgeBaseConfiguration(CfnKnowledgeBasePropsMixin.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 CfnKnowledgeBasePropsMixin.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 CfnKnowledgeBasePropsMixin.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 CfnKnowledgeBasePropsMixin.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 CfnKnowledgeBasePropsMixin.Builder storageConfiguration(CfnKnowledgeBasePropsMixin.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

tags

@Stability(Stable)
public CfnKnowledgeBasePropsMixin.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 CfnKnowledgeBasePropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnKnowledgeBasePropsMixin.