Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. wisdom
  5. KnowledgeBase

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.wisdom.KnowledgeBase

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    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.

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The KnowledgeBase resource accepts the following input properties:

    KnowledgeBaseType Pulumi.AwsNative.Wisdom.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.
    Description string
    The description.
    Name string
    The name of the knowledge base.
    RenderingConfiguration Pulumi.AwsNative.Wisdom.Inputs.KnowledgeBaseRenderingConfiguration
    Information about how to render the content.
    ServerSideEncryptionConfiguration Pulumi.AwsNative.Wisdom.Inputs.KnowledgeBaseServerSideEncryptionConfiguration
    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 .
    SourceConfiguration Pulumi.AwsNative.Wisdom.Inputs.KnowledgeBaseSourceConfiguration
    The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.
    Tags List<Pulumi.AwsNative.Inputs.CreateOnlyTag>
    The tags used to organize, track, or control access for this resource.
    KnowledgeBaseType 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.
    Description string
    The description.
    Name string
    The name of the knowledge base.
    RenderingConfiguration KnowledgeBaseRenderingConfigurationArgs
    Information about how to render the content.
    ServerSideEncryptionConfiguration KnowledgeBaseServerSideEncryptionConfigurationArgs
    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 .
    SourceConfiguration KnowledgeBaseSourceConfigurationArgs
    The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.
    Tags CreateOnlyTagArgs
    The tags used to organize, track, or control access for this resource.
    knowledgeBaseType 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.
    description String
    The description.
    name String
    The name of the knowledge base.
    renderingConfiguration KnowledgeBaseRenderingConfiguration
    Information about how to render the content.
    serverSideEncryptionConfiguration KnowledgeBaseServerSideEncryptionConfiguration
    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 .
    sourceConfiguration KnowledgeBaseSourceConfiguration
    The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.
    tags List<CreateOnlyTag>
    The tags used to organize, track, or control access for this resource.
    knowledgeBaseType 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.
    description string
    The description.
    name string
    The name of the knowledge base.
    renderingConfiguration KnowledgeBaseRenderingConfiguration
    Information about how to render the content.
    serverSideEncryptionConfiguration KnowledgeBaseServerSideEncryptionConfiguration
    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 .
    sourceConfiguration KnowledgeBaseSourceConfiguration
    The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.
    tags CreateOnlyTag[]
    The tags used to organize, track, or control access for this resource.
    knowledge_base_type 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.
    description str
    The description.
    name str
    The name of the knowledge base.
    rendering_configuration KnowledgeBaseRenderingConfigurationArgs
    Information about how to render the content.
    server_side_encryption_configuration KnowledgeBaseServerSideEncryptionConfigurationArgs
    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 .
    source_configuration KnowledgeBaseSourceConfigurationArgs
    The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.
    tags Sequence[CreateOnlyTagArgs]
    The tags used to organize, track, or control access for this resource.
    knowledgeBaseType "EXTERNAL" | "CUSTOM" | "MESSAGE_TEMPLATES"
    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.
    description String
    The description.
    name String
    The name of the knowledge base.
    renderingConfiguration Property Map
    Information about how to render the content.
    serverSideEncryptionConfiguration Property Map
    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 .
    sourceConfiguration Property Map
    The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.
    tags List<Property Map>
    The tags used to organize, track, or control access for this resource.

    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
    The Amazon Resource Name (ARN) of the knowledge base.
    KnowledgeBaseId string
    The ID of the knowledge base.
    Id string
    The provider-assigned unique ID for this managed resource.
    KnowledgeBaseArn string
    The Amazon Resource Name (ARN) of the knowledge base.
    KnowledgeBaseId string
    The ID of the knowledge base.
    id String
    The provider-assigned unique ID for this managed resource.
    knowledgeBaseArn String
    The Amazon Resource Name (ARN) of the knowledge base.
    knowledgeBaseId String
    The ID of the knowledge base.
    id string
    The provider-assigned unique ID for this managed resource.
    knowledgeBaseArn string
    The Amazon Resource Name (ARN) of the knowledge base.
    knowledgeBaseId string
    The ID of the knowledge base.
    id str
    The provider-assigned unique ID for this managed resource.
    knowledge_base_arn str
    The Amazon Resource Name (ARN) of the knowledge base.
    knowledge_base_id str
    The ID of the knowledge base.
    id String
    The provider-assigned unique ID for this managed resource.
    knowledgeBaseArn String
    The Amazon Resource Name (ARN) of the knowledge base.
    knowledgeBaseId String
    The ID of the knowledge base.

    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

    The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

    • For Salesforce , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted as source fields.
    • For ServiceNow , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number , short_description , sys_mod_count , workflow_state , and active as source fields.
    • For Zendesk , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id , title , updated_at , and draft as source fields.
    • For SharePoint , your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx , pdf , html , htm , and txt .
    • For Amazon S3 , the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name .

    The bucket policy of the corresponding S3 bucket must allow the AWS principal app-integrations.amazonaws.com to perform s3:ListBucket , s3:GetObject , and s3:GetBucketLocation against the bucket.

    ObjectFields List<string>

    The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.

    • For Salesforce , you must include at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted .
    • For ServiceNow , you must include at least number , short_description , sys_mod_count , workflow_state , and active .
    • For Zendesk , you must include at least id , title , updated_at , and draft .

    Make sure to include additional fields. These fields are indexed and used to source recommendations.

    AppIntegrationArn string

    The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

    • For Salesforce , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted as source fields.
    • For ServiceNow , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number , short_description , sys_mod_count , workflow_state , and active as source fields.
    • For Zendesk , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id , title , updated_at , and draft as source fields.
    • For SharePoint , your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx , pdf , html , htm , and txt .
    • For Amazon S3 , the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name .

    The bucket policy of the corresponding S3 bucket must allow the AWS principal app-integrations.amazonaws.com to perform s3:ListBucket , s3:GetObject , and s3:GetBucketLocation against the bucket.

    ObjectFields []string

    The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.

    • For Salesforce , you must include at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted .
    • For ServiceNow , you must include at least number , short_description , sys_mod_count , workflow_state , and active .
    • For Zendesk , you must include at least id , title , updated_at , and draft .

    Make sure to include additional fields. These fields are indexed and used to source recommendations.

    appIntegrationArn String

    The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

    • For Salesforce , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted as source fields.
    • For ServiceNow , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number , short_description , sys_mod_count , workflow_state , and active as source fields.
    • For Zendesk , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id , title , updated_at , and draft as source fields.
    • For SharePoint , your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx , pdf , html , htm , and txt .
    • For Amazon S3 , the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name .

    The bucket policy of the corresponding S3 bucket must allow the AWS principal app-integrations.amazonaws.com to perform s3:ListBucket , s3:GetObject , and s3:GetBucketLocation against the bucket.

    objectFields List<String>

    The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.

    • For Salesforce , you must include at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted .
    • For ServiceNow , you must include at least number , short_description , sys_mod_count , workflow_state , and active .
    • For Zendesk , you must include at least id , title , updated_at , and draft .

    Make sure to include additional fields. These fields are indexed and used to source recommendations.

    appIntegrationArn string

    The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

    • For Salesforce , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted as source fields.
    • For ServiceNow , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number , short_description , sys_mod_count , workflow_state , and active as source fields.
    • For Zendesk , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id , title , updated_at , and draft as source fields.
    • For SharePoint , your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx , pdf , html , htm , and txt .
    • For Amazon S3 , the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name .

    The bucket policy of the corresponding S3 bucket must allow the AWS principal app-integrations.amazonaws.com to perform s3:ListBucket , s3:GetObject , and s3:GetBucketLocation against the bucket.

    objectFields string[]

    The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.

    • For Salesforce , you must include at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted .
    • For ServiceNow , you must include at least number , short_description , sys_mod_count , workflow_state , and active .
    • For Zendesk , you must include at least id , title , updated_at , and draft .

    Make sure to include additional fields. These fields are indexed and used to source recommendations.

    app_integration_arn str

    The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

    • For Salesforce , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted as source fields.
    • For ServiceNow , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number , short_description , sys_mod_count , workflow_state , and active as source fields.
    • For Zendesk , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id , title , updated_at , and draft as source fields.
    • For SharePoint , your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx , pdf , html , htm , and txt .
    • For Amazon S3 , the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name .

    The bucket policy of the corresponding S3 bucket must allow the AWS principal app-integrations.amazonaws.com to perform s3:ListBucket , s3:GetObject , and s3:GetBucketLocation against the bucket.

    object_fields Sequence[str]

    The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.

    • For Salesforce , you must include at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted .
    • For ServiceNow , you must include at least number , short_description , sys_mod_count , workflow_state , and active .
    • For Zendesk , you must include at least id , title , updated_at , and draft .

    Make sure to include additional fields. These fields are indexed and used to source recommendations.

    appIntegrationArn String

    The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

    • For Salesforce , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted as source fields.
    • For ServiceNow , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number , short_description , sys_mod_count , workflow_state , and active as source fields.
    • For Zendesk , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id , title , updated_at , and draft as source fields.
    • For SharePoint , your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx , pdf , html , htm , and txt .
    • For Amazon S3 , the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name .

    The bucket policy of the corresponding S3 bucket must allow the AWS principal app-integrations.amazonaws.com to perform s3:ListBucket , s3:GetObject , and s3:GetBucketLocation against the bucket.

    objectFields List<String>

    The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.

    • For Salesforce , you must include at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted .
    • For ServiceNow , you must include at least number , short_description , sys_mod_count , workflow_state , and active .
    • For Zendesk , you must include at least id , title , updated_at , and draft .

    Make sure to include additional fields. These fields are indexed and used to source recommendations.

    KnowledgeBaseRenderingConfiguration, KnowledgeBaseRenderingConfigurationArgs

    TemplateUri string

    A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

    • Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeleted
    • ServiceNow: number , short_description , sys_mod_count , workflow_state , or active
    • Zendesk: id , title , updated_at , or draft

    The variable is replaced with the actual value for a piece of content when calling GetContent .

    TemplateUri string

    A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

    • Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeleted
    • ServiceNow: number , short_description , sys_mod_count , workflow_state , or active
    • Zendesk: id , title , updated_at , or draft

    The variable is replaced with the actual value for a piece of content when calling GetContent .

    templateUri String

    A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

    • Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeleted
    • ServiceNow: number , short_description , sys_mod_count , workflow_state , or active
    • Zendesk: id , title , updated_at , or draft

    The variable is replaced with the actual value for a piece of content when calling GetContent .

    templateUri string

    A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

    • Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeleted
    • ServiceNow: number , short_description , sys_mod_count , workflow_state , or active
    • Zendesk: id , title , updated_at , or draft

    The variable is replaced with the actual value for a piece of content when calling GetContent .

    template_uri str

    A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

    • Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeleted
    • ServiceNow: number , short_description , sys_mod_count , workflow_state , or active
    • Zendesk: id , title , updated_at , or draft

    The variable is replaced with the actual value for a piece of content when calling GetContent .

    templateUri String

    A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

    • Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeleted
    • ServiceNow: number , short_description , sys_mod_count , workflow_state , or active
    • Zendesk: id , title , updated_at , or draft

    The variable is replaced with the actual value for a piece of content when calling GetContent .

    KnowledgeBaseServerSideEncryptionConfiguration, KnowledgeBaseServerSideEncryptionConfigurationArgs

    KmsKeyId string

    The customer managed key used for encryption.

    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) .

    KmsKeyId string

    The customer managed key used for encryption.

    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) .

    kmsKeyId String

    The customer managed key used for encryption.

    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) .

    kmsKeyId string

    The customer managed key used for encryption.

    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) .

    kms_key_id str

    The customer managed key used for encryption.

    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) .

    kmsKeyId String

    The customer managed key used for encryption.

    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) .

    KnowledgeBaseSourceConfiguration, KnowledgeBaseSourceConfigurationArgs

    AppIntegrations Pulumi.AwsNative.Wisdom.Inputs.KnowledgeBaseAppIntegrationsConfiguration
    Configuration information for Amazon AppIntegrations to automatically ingest content.
    AppIntegrations KnowledgeBaseAppIntegrationsConfiguration
    Configuration information for Amazon AppIntegrations to automatically ingest content.
    appIntegrations KnowledgeBaseAppIntegrationsConfiguration
    Configuration information for Amazon AppIntegrations to automatically ingest content.
    appIntegrations KnowledgeBaseAppIntegrationsConfiguration
    Configuration information for Amazon AppIntegrations to automatically ingest content.
    app_integrations KnowledgeBaseAppIntegrationsConfiguration
    Configuration information for Amazon AppIntegrations to automatically ingest content.
    appIntegrations Property Map
    Configuration information for Amazon AppIntegrations to automatically ingest content.

    KnowledgeBaseType, KnowledgeBaseTypeArgs

    External
    EXTERNAL
    Custom
    CUSTOM
    MessageTemplates
    MESSAGE_TEMPLATES
    KnowledgeBaseTypeExternal
    EXTERNAL
    KnowledgeBaseTypeCustom
    CUSTOM
    KnowledgeBaseTypeMessageTemplates
    MESSAGE_TEMPLATES
    External
    EXTERNAL
    Custom
    CUSTOM
    MessageTemplates
    MESSAGE_TEMPLATES
    External
    EXTERNAL
    Custom
    CUSTOM
    MessageTemplates
    MESSAGE_TEMPLATES
    EXTERNAL
    EXTERNAL
    CUSTOM
    CUSTOM
    MESSAGE_TEMPLATES
    MESSAGE_TEMPLATES
    "EXTERNAL"
    EXTERNAL
    "CUSTOM"
    CUSTOM
    "MESSAGE_TEMPLATES"
    MESSAGE_TEMPLATES

    Package Details

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

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native