Struct SharePointConfigurationBuilder 

#[non_exhaustive]
pub struct SharePointConfigurationBuilder { /* private fields */ }

A builder for SharePointConfiguration.

Implementations

impl SharePointConfigurationBuilder

pub fn share_point_version(self, input: SharePointVersion) -> Self

The version of Microsoft SharePoint that you use.

This field is required.

pub fn set_share_point_version(self, input: Option<SharePointVersion>) -> Self

The version of Microsoft SharePoint that you use.

pub fn get_share_point_version(&self) -> &Option<SharePointVersion>

The version of Microsoft SharePoint that you use.

pub fn urls(self, input: impl Into<String>) -> Self

Appends an item to urls.

To override the contents of this collection use set_urls.

The Microsoft SharePoint site URLs for the documents you want to index.

pub fn set_urls(self, input: Option<Vec<String>>) -> Self

The Microsoft SharePoint site URLs for the documents you want to index.

pub fn get_urls(&self) -> &Option<Vec<String>>

The Microsoft SharePoint site URLs for the documents you want to index.

pub fn secret_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. For more information, see Microsoft SharePoint.

This field is required.

pub fn set_secret_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. For more information, see Microsoft SharePoint.

pub fn get_secret_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. For more information, see Microsoft SharePoint.

pub fn crawl_attachments(self, input: bool) -> Self

TRUE to index document attachments.

pub fn set_crawl_attachments(self, input: Option<bool>) -> Self

TRUE to index document attachments.

pub fn get_crawl_attachments(&self) -> &Option<bool>

TRUE to index document attachments.

pub fn use_change_log(self, input: bool) -> Self

TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.

pub fn set_use_change_log(self, input: Option<bool>) -> Self

TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.

pub fn get_use_change_log(&self) -> &Option<bool>

TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.

pub fn inclusion_patterns(self, input: impl Into<String>) -> Self

Appends an item to inclusion_patterns.

To override the contents of this collection use set_inclusion_patterns.

A list of regular expression patterns to include certain documents in your SharePoint. 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 regex applies to the display URL of the SharePoint document.

pub fn set_inclusion_patterns(self, input: Option<Vec<String>>) -> Self

A list of regular expression patterns to include certain documents in your SharePoint. 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 regex applies to the display URL of the SharePoint document.

pub fn get_inclusion_patterns(&self) -> &Option<Vec<String>>

A list of regular expression patterns to include certain documents in your SharePoint. 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 regex applies to the display URL of the SharePoint document.

pub fn exclusion_patterns(self, input: impl Into<String>) -> Self

Appends an item to exclusion_patterns.

To override the contents of this collection use set_exclusion_patterns.

A list of regular expression patterns to exclude certain documents in your SharePoint. 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 regex applies to the display URL of the SharePoint document.

pub fn set_exclusion_patterns(self, input: Option<Vec<String>>) -> Self

A list of regular expression patterns to exclude certain documents in your SharePoint. 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 regex applies to the display URL of the SharePoint document.

pub fn get_exclusion_patterns(&self) -> &Option<Vec<String>>

A list of regular expression patterns to exclude certain documents in your SharePoint. 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 regex applies to the display URL of the SharePoint document.

pub fn vpc_configuration(self, input: DataSourceVpcConfiguration) -> Self

Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft SharePoint. For more information, see Configuring a VPC.

pub fn set_vpc_configuration( self, input: Option<DataSourceVpcConfiguration>, ) -> Self

Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft SharePoint. For more information, see Configuring a VPC.

pub fn get_vpc_configuration(&self) -> &Option<DataSourceVpcConfiguration>

Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft SharePoint. For more information, see Configuring a VPC.

pub fn field_mappings(self, input: DataSourceToIndexFieldMapping) -> Self

Appends an item to field_mappings.

To override the contents of this collection use set_field_mappings.

A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.

pub fn set_field_mappings( self, input: Option<Vec<DataSourceToIndexFieldMapping>>, ) -> Self

A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.

pub fn get_field_mappings(&self) -> &Option<Vec<DataSourceToIndexFieldMapping>>

A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.

pub fn document_title_field_name(self, input: impl Into<String>) -> Self

The Microsoft SharePoint attribute field that contains the title of the document.

pub fn set_document_title_field_name(self, input: Option<String>) -> Self

The Microsoft SharePoint attribute field that contains the title of the document.

pub fn get_document_title_field_name(&self) -> &Option<String>

The Microsoft SharePoint attribute field that contains the title of the document.

pub fn disable_local_groups(self, input: bool) -> Self

TRUE to disable local groups information.

pub fn set_disable_local_groups(self, input: Option<bool>) -> Self

TRUE to disable local groups information.

pub fn get_disable_local_groups(&self) -> &Option<bool>

TRUE to disable local groups information.

pub fn ssl_certificate_s3_path(self, input: S3Path) -> Self

The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint Server if you require a secure SSL connection.

You can generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.

pub fn set_ssl_certificate_s3_path(self, input: Option<S3Path>) -> Self

The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint Server if you require a secure SSL connection.

You can generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.

pub fn get_ssl_certificate_s3_path(&self) -> &Option<S3Path>

The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint Server if you require a secure SSL connection.

You can generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.

pub fn authentication_type( self, input: SharePointOnlineAuthenticationType, ) -> Self

Whether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret.

pub fn set_authentication_type( self, input: Option<SharePointOnlineAuthenticationType>, ) -> Self

Whether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret.

pub fn get_authentication_type( &self, ) -> &Option<SharePointOnlineAuthenticationType>

Whether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret.

pub fn proxy_configuration(self, input: ProxyConfiguration) -> Self

Configuration information to connect to your Microsoft SharePoint site URLs via instance via a web proxy. You can use this option for SharePoint Server.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in Secrets Manager.

It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements.

pub fn set_proxy_configuration(self, input: Option<ProxyConfiguration>) -> Self

Configuration information to connect to your Microsoft SharePoint site URLs via instance via a web proxy. You can use this option for SharePoint Server.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in Secrets Manager.

It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements.

pub fn get_proxy_configuration(&self) -> &Option<ProxyConfiguration>

Configuration information to connect to your Microsoft SharePoint site URLs via instance via a web proxy. You can use this option for SharePoint Server.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in Secrets Manager.

It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements.

pub fn build(self) -> Result<SharePointConfiguration, BuildError>

Consumes the builder and constructs a SharePointConfiguration. This method will fail if any of the following fields are not set:

• share_point_version
• urls
• secret_arn

Trait Implementations

impl Clone for SharePointConfigurationBuilder

fn clone(&self) -> SharePointConfigurationBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SharePointConfigurationBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SharePointConfigurationBuilder

fn default() -> SharePointConfigurationBuilder

Returns the “default value” for a type.

impl PartialEq for SharePointConfigurationBuilder

fn eq(&self, other: &SharePointConfigurationBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SharePointConfigurationBuilder