1. Packages
  2. AWS Native
  3. API Docs
  4. wisdom
  5. KnowledgeBase

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.wisdom.KnowledgeBase

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    Definition of AWS::Wisdom::KnowledgeBase Resource Type

    Create KnowledgeBase Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new KnowledgeBase(name: string, args: KnowledgeBaseArgs, opts?: CustomResourceOptions);
    @overload
    def KnowledgeBase(resource_name: str,
                      args: KnowledgeBaseArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def KnowledgeBase(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      knowledge_base_type: Optional[KnowledgeBaseType] = None,
                      description: Optional[str] = None,
                      name: Optional[str] = None,
                      rendering_configuration: Optional[KnowledgeBaseRenderingConfigurationArgs] = None,
                      server_side_encryption_configuration: Optional[KnowledgeBaseServerSideEncryptionConfigurationArgs] = None,
                      source_configuration: Optional[KnowledgeBaseSourceConfigurationArgs] = None,
                      tags: Optional[Sequence[_root_inputs.CreateOnlyTagArgs]] = None)
    func NewKnowledgeBase(ctx *Context, name string, args KnowledgeBaseArgs, opts ...ResourceOption) (*KnowledgeBase, error)
    public KnowledgeBase(string name, KnowledgeBaseArgs args, CustomResourceOptions? opts = null)
    public KnowledgeBase(String name, KnowledgeBaseArgs args)
    public KnowledgeBase(String name, KnowledgeBaseArgs args, CustomResourceOptions options)
    
    type: aws-native:wisdom:KnowledgeBase
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args KnowledgeBaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args KnowledgeBaseArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args KnowledgeBaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KnowledgeBaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KnowledgeBaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const aws_nativeKnowledgeBaseResource = new aws_native.wisdom.KnowledgeBase("aws-nativeKnowledgeBaseResource", {
        knowledgeBaseType: aws_native.wisdom.KnowledgeBaseType.External,
        description: "string",
        name: "string",
        renderingConfiguration: {
            templateUri: "string",
        },
        serverSideEncryptionConfiguration: {
            kmsKeyId: "string",
        },
        sourceConfiguration: {
            appIntegrations: {
                appIntegrationArn: "string",
                objectFields: ["string"],
            },
        },
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    KnowledgeBase Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The KnowledgeBase resource accepts the following input properties:

    Outputs

    All input properties are implicitly available as output properties. Additionally, the KnowledgeBase resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    KnowledgeBaseArn string
    KnowledgeBaseId string
    Id string
    The provider-assigned unique ID for this managed resource.
    KnowledgeBaseArn string
    KnowledgeBaseId string
    id String
    The provider-assigned unique ID for this managed resource.
    knowledgeBaseArn String
    knowledgeBaseId String
    id string
    The provider-assigned unique ID for this managed resource.
    knowledgeBaseArn string
    knowledgeBaseId string
    id str
    The provider-assigned unique ID for this managed resource.
    knowledge_base_arn str
    knowledge_base_id str
    id String
    The provider-assigned unique ID for this managed resource.
    knowledgeBaseArn String
    knowledgeBaseId String

    Supporting Types

    CreateOnlyTag, CreateOnlyTagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    KnowledgeBaseAppIntegrationsConfiguration, KnowledgeBaseAppIntegrationsConfigurationArgs

    AppIntegrationArn string
    ObjectFields List<string>
    appIntegrationArn String
    objectFields List<String>
    appIntegrationArn String
    objectFields List<String>

    KnowledgeBaseRenderingConfiguration, KnowledgeBaseRenderingConfigurationArgs

    KnowledgeBaseServerSideEncryptionConfiguration, KnowledgeBaseServerSideEncryptionConfigurationArgs

    KmsKeyId string
    KmsKeyId string
    kmsKeyId String
    kmsKeyId string
    kmsKeyId String

    KnowledgeBaseSourceConfiguration, KnowledgeBaseSourceConfigurationArgs

    KnowledgeBaseType, KnowledgeBaseTypeArgs

    External
    EXTERNAL
    Custom
    CUSTOM
    KnowledgeBaseTypeExternal
    EXTERNAL
    KnowledgeBaseTypeCustom
    CUSTOM
    External
    EXTERNAL
    Custom
    CUSTOM
    External
    EXTERNAL
    Custom
    CUSTOM
    EXTERNAL
    EXTERNAL
    CUSTOM
    CUSTOM
    "EXTERNAL"
    EXTERNAL
    "CUSTOM"
    CUSTOM

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi