Package software.amazon.awscdk.services.wisdom

Class CfnKnowledgeBase.Builder

java.lang.Object

software.amazon.awscdk.services.wisdom.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.
CfnKnowledgeBase.Builder	knowledgeBaseType(String knowledgeBaseType)	The type of knowledge base.
CfnKnowledgeBase.Builder	name(String name)	The name of the knowledge base.
CfnKnowledgeBase.Builder	renderingConfiguration(IResolvable renderingConfiguration)	Information about how to render the content.
CfnKnowledgeBase.Builder	renderingConfiguration(CfnKnowledgeBase.RenderingConfigurationProperty renderingConfiguration)	Information about how to render the content.
CfnKnowledgeBase.Builder	serverSideEncryptionConfiguration(IResolvable serverSideEncryptionConfiguration)	This customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom.
CfnKnowledgeBase.Builder	serverSideEncryptionConfiguration(CfnKnowledgeBase.ServerSideEncryptionConfigurationProperty serverSideEncryptionConfiguration)	This customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom.
CfnKnowledgeBase.Builder	sourceConfiguration(IResolvable sourceConfiguration)	The source of the knowledge base content.
CfnKnowledgeBase.Builder	sourceConfiguration(CfnKnowledgeBase.SourceConfigurationProperty sourceConfiguration)	The source of the knowledge base content.
CfnKnowledgeBase.Builder	tags(List<? extends CfnTag> tags)	The tags used to organize, track, or control access for this resource.
CfnKnowledgeBase.Builder	vectorIngestionConfiguration(IResolvable vectorIngestionConfiguration)	Contains details about how to ingest the documents in a data source.
CfnKnowledgeBase.Builder	vectorIngestionConfiguration(CfnKnowledgeBase.VectorIngestionConfigurationProperty vectorIngestionConfiguration)	Contains details about how to ingest the documents in a data source.

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.

knowledgeBaseType

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

The type of knowledge base.

Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

Parameters:

knowledgeBaseType - The type of knowledge base. This parameter is required.

Returns:

this

See Also:

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

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-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-name

description

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

The description.

Parameters:

description - The description. This parameter is required.

Returns:

this

See Also:

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

renderingConfiguration

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

Information about how to render the content.

Parameters:

renderingConfiguration - Information about how to render the content. This parameter is required.

Returns:

this

See Also:

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

renderingConfiguration

@Stability(Stable)
public CfnKnowledgeBase.Builder renderingConfiguration(CfnKnowledgeBase.RenderingConfigurationProperty renderingConfiguration)

Information about how to render the content.

Parameters:

renderingConfiguration - Information about how to render the content. This parameter is required.

Returns:

this

See Also:

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

serverSideEncryptionConfiguration

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

This customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom.

For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance . For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .

Parameters:

serverSideEncryptionConfiguration - This customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom. This parameter is required.

Returns:

this

See Also:

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

serverSideEncryptionConfiguration

@Stability(Stable)
public CfnKnowledgeBase.Builder serverSideEncryptionConfiguration(CfnKnowledgeBase.ServerSideEncryptionConfigurationProperty serverSideEncryptionConfiguration)

This customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom.

For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance . For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .

Parameters:

serverSideEncryptionConfiguration - This customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom. This parameter is required.

Returns:

this

See Also:

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

sourceConfiguration

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

The source of the knowledge base content.

Only set this argument for EXTERNAL or Managed knowledge bases.

Parameters:

sourceConfiguration - The source of the knowledge base content. This parameter is required.

Returns:

this

See Also:

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

sourceConfiguration

@Stability(Stable)
public CfnKnowledgeBase.Builder sourceConfiguration(CfnKnowledgeBase.SourceConfigurationProperty sourceConfiguration)

The source of the knowledge base content.

Only set this argument for EXTERNAL or Managed knowledge bases.

Parameters:

sourceConfiguration - The source of the knowledge base content. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnKnowledgeBase.Builder tags(List<? extends CfnTag> tags)

The tags used to organize, track, or control access for this resource.

Parameters:

tags - The tags used to organize, track, or control access for this resource. This parameter is required.

Returns:

this

See Also:

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

vectorIngestionConfiguration

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

Contains details about how to ingest the documents in a data source.

Parameters:

vectorIngestionConfiguration - Contains details about how to ingest the documents in a data source. This parameter is required.

Returns:

this

See Also:

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

vectorIngestionConfiguration

@Stability(Stable)
public CfnKnowledgeBase.Builder vectorIngestionConfiguration(CfnKnowledgeBase.VectorIngestionConfigurationProperty vectorIngestionConfiguration)

Contains details about how to ingest the documents in a data source.

Parameters:

vectorIngestionConfiguration - Contains details about how to ingest the documents in a data source. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnKnowledgeBase build()

Specified by:

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

Returns:

a newly built instance of CfnKnowledgeBase.