Package software.amazon.awscdk.services.wisdom

Class CfnKnowledgeBase.AppIntegrationsConfigurationProperty.Builder

java.lang.Object
software.amazon.awscdk.services.wisdom.CfnKnowledgeBase.AppIntegrationsConfigurationProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnKnowledgeBase.AppIntegrationsConfigurationProperty>
Enclosing interface:
CfnKnowledgeBase.AppIntegrationsConfigurationProperty
@Stability(Stable) public static final class CfnKnowledgeBase.AppIntegrationsConfigurationProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnKnowledgeBase.AppIntegrationsConfigurationProperty>
A builder for CfnKnowledgeBase.AppIntegrationsConfigurationProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • appIntegrationArn

      @Stability(Stable) public CfnKnowledgeBase.AppIntegrationsConfigurationProperty.Builder appIntegrationArn(String appIntegrationArn)
      Sets the value of CfnKnowledgeBase.AppIntegrationsConfigurationProperty.getAppIntegrationArn()
      Parameters:
      appIntegrationArn - The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content. This parameter is required.
      • 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.

      Returns:
      this

    • objectFields

      @Stability(Stable) public CfnKnowledgeBase.AppIntegrationsConfigurationProperty.Builder objectFields(List<String> objectFields)
      Sets the value of CfnKnowledgeBase.AppIntegrationsConfigurationProperty.getObjectFields()
      Parameters:
      objectFields - 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.

      Returns:
      this

    • build

      @Stability(Stable) public CfnKnowledgeBase.AppIntegrationsConfigurationProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnKnowledgeBase.AppIntegrationsConfigurationProperty>
      Returns:
      a new instance of CfnKnowledgeBase.AppIntegrationsConfigurationProperty
      Throws:
      NullPointerException - if any required attribute was not provided