Struct BoxConfiguration 

#[non_exhaustive]
pub struct BoxConfiguration {

    pub enterprise_id: String,
    pub secret_arn: String,
    pub use_change_log: bool,
    pub crawl_comments: bool,
    pub crawl_tasks: bool,
    pub crawl_web_links: bool,
    pub file_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>,
    pub task_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>,
    pub comment_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>,
    pub web_link_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>,
    pub inclusion_patterns: Option<Vec<String>>,
    pub exclusion_patterns: Option<Vec<String>>,
    pub vpc_configuration: Option<DataSourceVpcConfiguration>,
}

Provides the configuration information to connect to Box as your data source.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

enterprise_id: String

The identifier of the Box Enterprise platform. You can find the enterprise ID in the Box Developer Console settings or when you create an app in Box and download your authentication credentials. For example, 801234567.

secret_arn: String

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Box platform. The secret must contain a JSON structure with the following keys:

• clientID—The identifier of the client OAuth 2.0 authentication application created in Box.

• clientSecret—A set of characters known only to the OAuth 2.0 authentication application created in Box.

• publicKeyId—The identifier of the public key contained within an identity certificate.

• privateKey—A set of characters that make up an encryption key.

• passphrase—A set of characters that act like a password.

You create an application in Box to generate the keys or credentials required for the secret. For more information, see Using a Box data source.

use_change_log: bool

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

crawl_comments: bool

TRUE to index comments.

crawl_tasks: bool

TRUE to index the contents of tasks.

crawl_web_links: bool

TRUE to index web links.

file_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>

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

task_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>

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

comment_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>

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

web_link_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>

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

inclusion_patterns: Option<Vec<String>>

A list of regular expression patterns to include certain files and folders in your Box platform. Files and folders that match the patterns are included in the index. Files and folders that don't match the patterns are excluded from the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.

exclusion_patterns: Option<Vec<String>>

A list of regular expression patterns to exclude certain files and folders from your Box platform. Files and folders that match the patterns are excluded from the index.Files and folders that don't match the patterns are included in the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.

vpc_configuration: Option<DataSourceVpcConfiguration>

Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.

Implementations

impl BoxConfiguration

pub fn enterprise_id(&self) -> &str

The identifier of the Box Enterprise platform. You can find the enterprise ID in the Box Developer Console settings or when you create an app in Box and download your authentication credentials. For example, 801234567.

pub fn secret_arn(&self) -> &str

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Box platform. The secret must contain a JSON structure with the following keys:

• clientID—The identifier of the client OAuth 2.0 authentication application created in Box.

• clientSecret—A set of characters known only to the OAuth 2.0 authentication application created in Box.

• publicKeyId—The identifier of the public key contained within an identity certificate.

• privateKey—A set of characters that make up an encryption key.

• passphrase—A set of characters that act like a password.

You create an application in Box to generate the keys or credentials required for the secret. For more information, see Using a Box data source.

pub fn use_change_log(&self) -> bool

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

pub fn crawl_comments(&self) -> bool

TRUE to index comments.

pub fn crawl_tasks(&self) -> bool

TRUE to index the contents of tasks.

pub fn crawl_web_links(&self) -> bool

TRUE to index web links.

pub fn file_field_mappings(&self) -> &[DataSourceToIndexFieldMapping]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .file_field_mappings.is_none().

pub fn task_field_mappings(&self) -> &[DataSourceToIndexFieldMapping]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .task_field_mappings.is_none().

pub fn comment_field_mappings(&self) -> &[DataSourceToIndexFieldMapping]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .comment_field_mappings.is_none().

pub fn web_link_field_mappings(&self) -> &[DataSourceToIndexFieldMapping]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .web_link_field_mappings.is_none().

pub fn inclusion_patterns(&self) -> &[String]

A list of regular expression patterns to include certain files and folders in your Box platform. Files and folders that match the patterns are included in the index. Files and folders that don't match the patterns are excluded from the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .inclusion_patterns.is_none().

pub fn exclusion_patterns(&self) -> &[String]

A list of regular expression patterns to exclude certain files and folders from your Box platform. Files and folders that match the patterns are excluded from the index.Files and folders that don't match the patterns are included in the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .exclusion_patterns.is_none().

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

Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.

impl BoxConfiguration

pub fn builder() -> BoxConfigurationBuilder

Creates a new builder-style object to manufacture BoxConfiguration.

Trait Implementations

impl Clone for BoxConfiguration

fn clone(&self) -> BoxConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BoxConfiguration

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

Formats the value using the given formatter.

impl PartialEq for BoxConfiguration

fn eq(&self, other: &BoxConfiguration) -> 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 BoxConfiguration