Skip to content
v2.277.0

AppIntegrationsConfigurationProperty Struct ​

Configuration information for Amazon AppIntegrations to automatically ingest content.

Example ​

ts
// 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'],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_wisdom as wisdom

app_integrations_configuration_property = wisdom.CfnKnowledgeBase.AppIntegrationsConfigurationProperty(
    app_integration_arn="appIntegrationArn",

    # the properties below are optional
    object_fields=["objectFields"]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.wisdom.*;

AppIntegrationsConfigurationProperty appIntegrationsConfigurationProperty = AppIntegrationsConfigurationProperty.builder()
        .appIntegrationArn("appIntegrationArn")

        // the properties below are optional
        .objectFields(List.of("objectFields"))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Wisdom;

var appIntegrationsConfigurationProperty = new AppIntegrationsConfigurationProperty {
    AppIntegrationArn = "appIntegrationArn",

    // the properties below are optional
    ObjectFields = new [] { "objectFields" }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

appIntegrationsConfigurationProperty := &AppIntegrationsConfigurationProperty{
	AppIntegrationArn: jsii.String("appIntegrationArn"),

	// the properties below are optional
	ObjectFields: []*string{
		jsii.String("objectFields"),
	},
}

Properties ​

appIntegrationArnstringapp_integration_arnstrappIntegrationArnStringAppIntegrationArnstringAppIntegrationArn*stringrequired#
The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
notes
  • 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.

objectFieldsoptionalstring[]object_fieldsoptionaltyping.List[str]objectFieldsoptionalList<String>ObjectFieldsoptionalstring[]ObjectFieldsoptional*[]*string#
The fields from the source that are made available to your agents in Amazon Q in Connect.
notes

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.