Class: AWSCDK::Kendra::CfnDataSource::DataSourceConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kendra/cfn_data_source.rb

Overview

Provides the configuration information for an Amazon Kendra data source.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(confluence_configuration: nil, database_configuration: nil, google_drive_configuration: nil, one_drive_configuration: nil, s3_configuration: nil, salesforce_configuration: nil, service_now_configuration: nil, share_point_configuration: nil, template_configuration: nil, web_crawler_configuration: nil, work_docs_configuration: nil) ⇒ DataSourceConfigurationProperty

Returns a new instance of DataSourceConfigurationProperty.

Parameters:



1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
# File 'kendra/cfn_data_source.rb', line 1534

def initialize(confluence_configuration: nil, database_configuration: nil, google_drive_configuration: nil, one_drive_configuration: nil, s3_configuration: nil, salesforce_configuration: nil, service_now_configuration: nil, share_point_configuration: nil, template_configuration: nil, web_crawler_configuration: nil, work_docs_configuration: nil)
  @confluence_configuration = confluence_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::ConfluenceConfigurationProperty.new(**confluence_configuration.transform_keys(&:to_sym)) : confluence_configuration
  Jsii::Type.check_type(@confluence_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5Db25mbHVlbmNlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "confluenceConfiguration") unless @confluence_configuration.nil?
  @database_configuration = database_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::DatabaseConfigurationProperty.new(**database_configuration.transform_keys(&:to_sym)) : database_configuration
  Jsii::Type.check_type(@database_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5EYXRhYmFzZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "databaseConfiguration") unless @database_configuration.nil?
  @google_drive_configuration = google_drive_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::GoogleDriveConfigurationProperty.new(**google_drive_configuration.transform_keys(&:to_sym)) : google_drive_configuration
  Jsii::Type.check_type(@google_drive_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5Hb29nbGVEcml2ZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "googleDriveConfiguration") unless @google_drive_configuration.nil?
  @one_drive_configuration = one_drive_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::OneDriveConfigurationProperty.new(**one_drive_configuration.transform_keys(&:to_sym)) : one_drive_configuration
  Jsii::Type.check_type(@one_drive_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5PbmVEcml2ZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "oneDriveConfiguration") unless @one_drive_configuration.nil?
  @s3_configuration = s3_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::S3DataSourceConfigurationProperty.new(**s3_configuration.transform_keys(&:to_sym)) : s3_configuration
  Jsii::Type.check_type(@s3_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5TM0RhdGFTb3VyY2VDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "s3Configuration") unless @s3_configuration.nil?
  @salesforce_configuration = salesforce_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::SalesforceConfigurationProperty.new(**salesforce_configuration.transform_keys(&:to_sym)) : salesforce_configuration
  Jsii::Type.check_type(@salesforce_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5TYWxlc2ZvcmNlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "salesforceConfiguration") unless @salesforce_configuration.nil?
  @service_now_configuration = service_now_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::ServiceNowConfigurationProperty.new(**service_now_configuration.transform_keys(&:to_sym)) : service_now_configuration
  Jsii::Type.check_type(@service_now_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5TZXJ2aWNlTm93Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "serviceNowConfiguration") unless @service_now_configuration.nil?
  @share_point_configuration = share_point_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::SharePointConfigurationProperty.new(**share_point_configuration.transform_keys(&:to_sym)) : share_point_configuration
  Jsii::Type.check_type(@share_point_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5TaGFyZVBvaW50Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "sharePointConfiguration") unless @share_point_configuration.nil?
  @template_configuration = template_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::TemplateConfigurationProperty.new(**template_configuration.transform_keys(&:to_sym)) : template_configuration
  Jsii::Type.check_type(@template_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5UZW1wbGF0ZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "templateConfiguration") unless @template_configuration.nil?
  @web_crawler_configuration = web_crawler_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::WebCrawlerConfigurationProperty.new(**web_crawler_configuration.transform_keys(&:to_sym)) : web_crawler_configuration
  Jsii::Type.check_type(@web_crawler_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5XZWJDcmF3bGVyQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "webCrawlerConfiguration") unless @web_crawler_configuration.nil?
  @work_docs_configuration = work_docs_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::WorkDocsConfigurationProperty.new(**work_docs_configuration.transform_keys(&:to_sym)) : work_docs_configuration
  Jsii::Type.check_type(@work_docs_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5Xb3JrRG9jc0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "workDocsConfiguration") unless @work_docs_configuration.nil?
end

Instance Attribute Details

#confluence_configurationAWSCDK::IResolvable, ... (readonly)

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



1563
1564
1565
# File 'kendra/cfn_data_source.rb', line 1563

def confluence_configuration
  @confluence_configuration
end

#database_configurationAWSCDK::IResolvable, ... (readonly)

Provides the configuration information to connect to a database as your data source.



1568
1569
1570
# File 'kendra/cfn_data_source.rb', line 1568

def database_configuration
  @database_configuration
end

#google_drive_configurationAWSCDK::IResolvable, ... (readonly)

Provides the configuration information to connect to Google Drive as your data source.



1573
1574
1575
# File 'kendra/cfn_data_source.rb', line 1573

def google_drive_configuration
  @google_drive_configuration
end

#one_drive_configurationAWSCDK::IResolvable, ... (readonly)

Provides the configuration information to connect to Microsoft OneDrive as your data source.



1578
1579
1580
# File 'kendra/cfn_data_source.rb', line 1578

def one_drive_configuration
  @one_drive_configuration
end

#s3_configurationAWSCDK::IResolvable, ... (readonly)

Provides the configuration information to connect to an Amazon S3 bucket as your data source.

Amazon Kendra now supports an upgraded Amazon S3 connector.

You must now use the TemplateConfiguration object instead of the S3DataSourceConfiguration object to configure your connector.

Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.

We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.



1591
1592
1593
# File 'kendra/cfn_data_source.rb', line 1591

def s3_configuration
  @s3_configuration
end

#salesforce_configurationAWSCDK::IResolvable, ... (readonly)

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



1596
1597
1598
# File 'kendra/cfn_data_source.rb', line 1596

def salesforce_configuration
  @salesforce_configuration
end

#service_now_configurationAWSCDK::IResolvable, ... (readonly)

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



1601
1602
1603
# File 'kendra/cfn_data_source.rb', line 1601

def service_now_configuration
  @service_now_configuration
end

#share_point_configurationAWSCDK::IResolvable, ... (readonly)

Provides the configuration information to connect to Microsoft SharePoint as your data source.



1606
1607
1608
# File 'kendra/cfn_data_source.rb', line 1606

def share_point_configuration
  @share_point_configuration
end

#template_configurationAWSCDK::IResolvable, ... (readonly)

Provides a template for the configuration information to connect to your data source.



1611
1612
1613
# File 'kendra/cfn_data_source.rb', line 1611

def template_configuration
  @template_configuration
end

#web_crawler_configurationAWSCDK::IResolvable, ... (readonly)

Provides the configuration information required for Amazon Kendra Web Crawler.



1616
1617
1618
# File 'kendra/cfn_data_source.rb', line 1616

def web_crawler_configuration
  @web_crawler_configuration
end

#work_docs_configurationAWSCDK::IResolvable, ... (readonly)

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



1621
1622
1623
# File 'kendra/cfn_data_source.rb', line 1621

def work_docs_configuration
  @work_docs_configuration
end

Class Method Details

.jsii_propertiesObject



1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
# File 'kendra/cfn_data_source.rb', line 1623

def self.jsii_properties
  {
    :confluence_configuration => "confluenceConfiguration",
    :database_configuration => "databaseConfiguration",
    :google_drive_configuration => "googleDriveConfiguration",
    :one_drive_configuration => "oneDriveConfiguration",
    :s3_configuration => "s3Configuration",
    :salesforce_configuration => "salesforceConfiguration",
    :service_now_configuration => "serviceNowConfiguration",
    :share_point_configuration => "sharePointConfiguration",
    :template_configuration => "templateConfiguration",
    :web_crawler_configuration => "webCrawlerConfiguration",
    :work_docs_configuration => "workDocsConfiguration",
  }
end

Instance Method Details

#to_jsiiObject



1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
# File 'kendra/cfn_data_source.rb', line 1639

def to_jsii
  result = {}
  result.merge!({
    "confluenceConfiguration" => @confluence_configuration,
    "databaseConfiguration" => @database_configuration,
    "googleDriveConfiguration" => @google_drive_configuration,
    "oneDriveConfiguration" => @one_drive_configuration,
    "s3Configuration" => @s3_configuration,
    "salesforceConfiguration" => @salesforce_configuration,
    "serviceNowConfiguration" => @service_now_configuration,
    "sharePointConfiguration" => @share_point_configuration,
    "templateConfiguration" => @template_configuration,
    "webCrawlerConfiguration" => @web_crawler_configuration,
    "workDocsConfiguration" => @work_docs_configuration,
  })
  result.compact
end