CfnKnowledgeBaseProps

class aws_cdk.aws_wisdom.CfnKnowledgeBaseProps(*, knowledge_base_type, name, description=None, rendering_configuration=None, server_side_encryption_configuration=None, source_configuration=None, tags=None)

Bases: object

Properties for defining a CfnKnowledgeBase.

Parameters:
  • knowledge_base_type (str) – 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.

  • name (str) – The name of the knowledge base.

  • description (Optional[str]) – The description.

  • rendering_configuration (Union[IResolvable, RenderingConfigurationProperty, Dict[str, Any], None]) – Information about how to render the content.

  • server_side_encryption_configuration (Union[IResolvable, ServerSideEncryptionConfigurationProperty, Dict[str, Any], None]) – The KMS key used for encryption.

  • source_configuration (Union[IResolvable, SourceConfigurationProperty, Dict[str, Any], None]) – The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags used to organize, track, or control access for this resource.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_wisdom as wisdom

cfn_knowledge_base_props = wisdom.CfnKnowledgeBaseProps(
    knowledge_base_type="knowledgeBaseType",
    name="name",

    # the properties below are optional
    description="description",
    rendering_configuration=wisdom.CfnKnowledgeBase.RenderingConfigurationProperty(
        template_uri="templateUri"
    ),
    server_side_encryption_configuration=wisdom.CfnKnowledgeBase.ServerSideEncryptionConfigurationProperty(
        kms_key_id="kmsKeyId"
    ),
    source_configuration=wisdom.CfnKnowledgeBase.SourceConfigurationProperty(
        app_integrations=wisdom.CfnKnowledgeBase.AppIntegrationsConfigurationProperty(
            app_integration_arn="appIntegrationArn",

            # the properties below are optional
            object_fields=["objectFields"]
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

The description.

Link:

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

knowledge_base_type

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.

Link:

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

name

The name of the knowledge base.

Link:

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

rendering_configuration

Information about how to render the content.

Link:

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

server_side_encryption_configuration

The KMS key used for encryption.

Link:

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

source_configuration

The source of the knowledge base content.

Only set this argument for EXTERNAL knowledge bases.

Link:

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

tags

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

Link:

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