Class CfnDataSource.SalesforceConfigurationProperty.Builder
java.lang.Object
software.amazon.awscdk.services.kendra.CfnDataSource.SalesforceConfigurationProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDataSource.SalesforceConfigurationProperty>
- Enclosing interface:
CfnDataSource.SalesforceConfigurationProperty
@Stability(Stable)
public static final class CfnDataSource.SalesforceConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDataSource.SalesforceConfigurationProperty>
A builder for
CfnDataSource.SalesforceConfigurationProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.chatterFeedConfiguration
(IResolvable chatterFeedConfiguration) chatterFeedConfiguration
(CfnDataSource.SalesforceChatterFeedConfigurationProperty chatterFeedConfiguration) crawlAttachments
(Boolean crawlAttachments) Sets the value ofCfnDataSource.SalesforceConfigurationProperty.getCrawlAttachments()
crawlAttachments
(IResolvable crawlAttachments) Sets the value ofCfnDataSource.SalesforceConfigurationProperty.getCrawlAttachments()
excludeAttachmentFilePatterns
(List<String> excludeAttachmentFilePatterns) includeAttachmentFilePatterns
(List<String> includeAttachmentFilePatterns) knowledgeArticleConfiguration
(IResolvable knowledgeArticleConfiguration) knowledgeArticleConfiguration
(CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty knowledgeArticleConfiguration) Sets the value ofCfnDataSource.SalesforceConfigurationProperty.getSecretArn()
Sets the value ofCfnDataSource.SalesforceConfigurationProperty.getServerUrl()
standardObjectAttachmentConfiguration
(IResolvable standardObjectAttachmentConfiguration) standardObjectAttachmentConfiguration
(CfnDataSource.SalesforceStandardObjectAttachmentConfigurationProperty standardObjectAttachmentConfiguration) standardObjectConfigurations
(List<? extends Object> standardObjectConfigurations) standardObjectConfigurations
(IResolvable standardObjectConfigurations)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
secretArn
@Stability(Stable) public CfnDataSource.SalesforceConfigurationProperty.Builder secretArn(String secretArn) Sets the value ofCfnDataSource.SalesforceConfigurationProperty.getSecretArn()
- Parameters:
secretArn
- The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance. This parameter is required. The secret must contain a JSON structure with the following keys:- authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
- consumerKey - The application public key generated when you created your Salesforce application.
- consumerSecret - The application private key generated when you created your Salesforce application.
- password - The password associated with the user logging in to the Salesforce instance.
- securityToken - The token associated with the user logging in to the Salesforce instance.
- username - The user name of the user logging in to the Salesforce instance.
- Returns:
this
-
serverUrl
@Stability(Stable) public CfnDataSource.SalesforceConfigurationProperty.Builder serverUrl(String serverUrl) Sets the value ofCfnDataSource.SalesforceConfigurationProperty.getServerUrl()
- Parameters:
serverUrl
- The instance URL for the Salesforce site that you want to index. This parameter is required.- Returns:
this
-
chatterFeedConfiguration
@Stability(Stable) public CfnDataSource.SalesforceConfigurationProperty.Builder chatterFeedConfiguration(IResolvable chatterFeedConfiguration) - Parameters:
chatterFeedConfiguration
- Configuration information for Salesforce chatter feeds.- Returns:
this
-
chatterFeedConfiguration
@Stability(Stable) public CfnDataSource.SalesforceConfigurationProperty.Builder chatterFeedConfiguration(CfnDataSource.SalesforceChatterFeedConfigurationProperty chatterFeedConfiguration) - Parameters:
chatterFeedConfiguration
- Configuration information for Salesforce chatter feeds.- Returns:
this
-
crawlAttachments
@Stability(Stable) public CfnDataSource.SalesforceConfigurationProperty.Builder crawlAttachments(Boolean crawlAttachments) Sets the value ofCfnDataSource.SalesforceConfigurationProperty.getCrawlAttachments()
- Parameters:
crawlAttachments
- Indicates whether Amazon Kendra should index attachments to Salesforce objects.- Returns:
this
-
crawlAttachments
@Stability(Stable) public CfnDataSource.SalesforceConfigurationProperty.Builder crawlAttachments(IResolvable crawlAttachments) Sets the value ofCfnDataSource.SalesforceConfigurationProperty.getCrawlAttachments()
- Parameters:
crawlAttachments
- Indicates whether Amazon Kendra should index attachments to Salesforce objects.- Returns:
this
-
excludeAttachmentFilePatterns
@Stability(Stable) public CfnDataSource.SalesforceConfigurationProperty.Builder excludeAttachmentFilePatterns(List<String> excludeAttachmentFilePatterns) - Parameters:
excludeAttachmentFilePatterns
- A list of regular expression patterns to exclude certain documents in your Salesforce. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.The pattern is applied to the name of the attached file.
- Returns:
this
-
includeAttachmentFilePatterns
@Stability(Stable) public CfnDataSource.SalesforceConfigurationProperty.Builder includeAttachmentFilePatterns(List<String> includeAttachmentFilePatterns) - Parameters:
includeAttachmentFilePatterns
- A list of regular expression patterns to include certain documents in your Salesforce. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.The pattern is applied to the name of the attached file.
- Returns:
this
-
knowledgeArticleConfiguration
@Stability(Stable) public CfnDataSource.SalesforceConfigurationProperty.Builder knowledgeArticleConfiguration(IResolvable knowledgeArticleConfiguration) - Parameters:
knowledgeArticleConfiguration
- Configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.- Returns:
this
-
knowledgeArticleConfiguration
@Stability(Stable) public CfnDataSource.SalesforceConfigurationProperty.Builder knowledgeArticleConfiguration(CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty knowledgeArticleConfiguration) - Parameters:
knowledgeArticleConfiguration
- Configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.- Returns:
this
-
standardObjectAttachmentConfiguration
@Stability(Stable) public CfnDataSource.SalesforceConfigurationProperty.Builder standardObjectAttachmentConfiguration(IResolvable standardObjectAttachmentConfiguration) Sets the value ofCfnDataSource.SalesforceConfigurationProperty.getStandardObjectAttachmentConfiguration()
- Parameters:
standardObjectAttachmentConfiguration
- Configuration information for processing attachments to Salesforce standard objects.- Returns:
this
-
standardObjectAttachmentConfiguration
@Stability(Stable) public CfnDataSource.SalesforceConfigurationProperty.Builder standardObjectAttachmentConfiguration(CfnDataSource.SalesforceStandardObjectAttachmentConfigurationProperty standardObjectAttachmentConfiguration) Sets the value ofCfnDataSource.SalesforceConfigurationProperty.getStandardObjectAttachmentConfiguration()
- Parameters:
standardObjectAttachmentConfiguration
- Configuration information for processing attachments to Salesforce standard objects.- Returns:
this
-
standardObjectConfigurations
@Stability(Stable) public CfnDataSource.SalesforceConfigurationProperty.Builder standardObjectConfigurations(IResolvable standardObjectConfigurations) - Parameters:
standardObjectConfigurations
- Configuration of the Salesforce standard objects that Amazon Kendra indexes.- Returns:
this
-
standardObjectConfigurations
@Stability(Stable) public CfnDataSource.SalesforceConfigurationProperty.Builder standardObjectConfigurations(List<? extends Object> standardObjectConfigurations) - Parameters:
standardObjectConfigurations
- Configuration of the Salesforce standard objects that Amazon Kendra indexes.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnDataSource.SalesforceConfigurationProperty>
- Returns:
- a new instance of
CfnDataSource.SalesforceConfigurationProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-