interface AppIntegrationsConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Wisdom.CfnKnowledgeBase.AppIntegrationsConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awswisdom#CfnKnowledgeBase_AppIntegrationsConfigurationProperty`
Java	`software.amazon.awscdk.services.wisdom.CfnKnowledgeBase.AppIntegrationsConfigurationProperty`
Python	`aws_cdk.aws_wisdom.CfnKnowledgeBase.AppIntegrationsConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_wisdom` » `CfnKnowledgeBase` » `AppIntegrationsConfigurationProperty`

Configuration information for Amazon AppIntegrations to automatically ingest content.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_wisdom as wisdom } from 'aws-cdk-lib';
const appIntegrationsConfigurationProperty: wisdom.CfnKnowledgeBase.AppIntegrationsConfigurationProperty = {
  appIntegrationArn: 'appIntegrationArn',

  // the properties below are optional
  objectFields: ['objectFields'],
};

Properties

Name	Type	Description
appIntegrationArn	`string`	The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
objectFields?	`string[]`	The fields from the source that are made available to your agents in Amazon Q in Connect.

appIntegrationArn

Type: 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?

Type: string[] (optional)

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.