Package software.amazon.awscdk.services.wisdom

Interface CfnKnowledgeBase.AppIntegrationsConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKnowledgeBase.AppIntegrationsConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnKnowledgeBase

@Stability(Stable)
public static interface CfnKnowledgeBase.AppIntegrationsConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.wisdom.*;
 AppIntegrationsConfigurationProperty appIntegrationsConfigurationProperty = AppIntegrationsConfigurationProperty.builder()
         .appIntegrationArn("appIntegrationArn")
         // the properties below are optional
         .objectFields(List.of("objectFields"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-appintegrationsconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnKnowledgeBase.AppIntegrationsConfigurationProperty.Builder	A builder for CfnKnowledgeBase.AppIntegrationsConfigurationProperty
static final class	CfnKnowledgeBase.AppIntegrationsConfigurationProperty.Jsii$Proxy	An implementation for CfnKnowledgeBase.AppIntegrationsConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnKnowledgeBase.AppIntegrationsConfigurationProperty.Builder	builder()
String	getAppIntegrationArn()	The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
default List<String>	getObjectFields()	The fields from the source that are made available to your agents in Amazon Q in Connect.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAppIntegrationArn

@Stability(Stable)
@NotNull
String getAppIntegrationArn()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-appintegrationsconfiguration.html#cfn-wisdom-knowledgebase-appintegrationsconfiguration-appintegrationarn

getObjectFields

@Stability(Stable)
@Nullable
default List<String> getObjectFields()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-appintegrationsconfiguration.html#cfn-wisdom-knowledgebase-appintegrationsconfiguration-objectfields

builder

@Stability(Stable)
static CfnKnowledgeBase.AppIntegrationsConfigurationProperty.Builder builder()

Returns:

a CfnKnowledgeBase.AppIntegrationsConfigurationProperty.Builder of CfnKnowledgeBase.AppIntegrationsConfigurationProperty