Class: AWSCDK::Kendra::CfnDataSource::DatabaseConfigurationProperty

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

Overview

Provides the configuration information to an Amazon Kendra supported database .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(column_configuration:, connection_configuration:, database_engine_type:, acl_configuration: nil, sql_configuration: nil, vpc_configuration: nil) ⇒ DatabaseConfigurationProperty

Returns a new instance of DatabaseConfigurationProperty.

Parameters:



1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
 
# File 'kendra/cfn_data_source.rb', line 1778

def initialize(column_configuration:, connection_configuration:, database_engine_type:, acl_configuration: nil, sql_configuration: nil, vpc_configuration: nil)
  @column_configuration = column_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::ColumnConfigurationProperty.new(**column_configuration.transform_keys(&:to_sym)) : column_configuration
  Jsii::Type.check_type(@column_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5Db2x1bW5Db25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "columnConfiguration")
  @connection_configuration = connection_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::ConnectionConfigurationProperty.new(**connection_configuration.transform_keys(&:to_sym)) : connection_configuration
  Jsii::Type.check_type(@connection_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5Db25uZWN0aW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "connectionConfiguration")
  @database_engine_type = database_engine_type
  Jsii::Type.check_type(@database_engine_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "databaseEngineType")
  @acl_configuration = acl_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::AclConfigurationProperty.new(**acl_configuration.transform_keys(&:to_sym)) : acl_configuration
  Jsii::Type.check_type(@acl_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5BY2xDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "aclConfiguration") unless @acl_configuration.nil?
  @sql_configuration = sql_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::SqlConfigurationProperty.new(**sql_configuration.transform_keys(&:to_sym)) : sql_configuration
  Jsii::Type.check_type(@sql_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5TcWxDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "sqlConfiguration") unless @sql_configuration.nil?
  @vpc_configuration = vpc_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::DataSourceVPCConfigurationProperty.new(**vpc_configuration.transform_keys(&:to_sym)) : vpc_configuration
  Jsii::Type.check_type(@vpc_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5EYXRhU291cmNlVnBjQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "vpcConfiguration") unless @vpc_configuration.nil?
end

Instance Attribute Details

#acl_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Information about the database column that provides information for user context filtering.

Returns:

See Also:



1812
1813
1814
 
# File 'kendra/cfn_data_source.rb', line 1812

def acl_configuration
  @acl_configuration
end

#column_configuration ⇒ AWSCDK::IResolvable, AWSCDK::Kendra::CfnDataSource::ColumnConfigurationProperty (readonly)

Information about where the index should get the document information from the database.

Returns:

See Also:



1797
1798
1799
 
# File 'kendra/cfn_data_source.rb', line 1797

def column_configuration
  @column_configuration
end

#connection_configuration ⇒ AWSCDK::IResolvable, AWSCDK::Kendra::CfnDataSource::ConnectionConfigurationProperty (readonly)

Configuration information that's required to connect to a database.

Returns:

See Also:



1802
1803
1804
 
# File 'kendra/cfn_data_source.rb', line 1802

def connection_configuration
  @connection_configuration
end

#database_engine_type ⇒ String (readonly)

The type of database engine that runs the database.

Returns:

  • (String)

See Also:



1807
1808
1809
 
# File 'kendra/cfn_data_source.rb', line 1807

def database_engine_type
  @database_engine_type
end

#sql_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.

Returns:

See Also:



1817
1818
1819
 
# File 'kendra/cfn_data_source.rb', line 1817

def sql_configuration
  @sql_configuration
end

#vpc_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Provides information for connecting to an Amazon VPC.

Returns:

See Also:



1822
1823
1824
 
# File 'kendra/cfn_data_source.rb', line 1822

def vpc_configuration
  @vpc_configuration
end

Class Method Details

.jsii_properties ⇒ Object 



1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
 
# File 'kendra/cfn_data_source.rb', line 1824

def self.jsii_properties
  {
    :column_configuration => "columnConfiguration",
    :connection_configuration => "connectionConfiguration",
    :database_engine_type => "databaseEngineType",
    :acl_configuration => "aclConfiguration",
    :sql_configuration => "sqlConfiguration",
    :vpc_configuration => "vpcConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
 
# File 'kendra/cfn_data_source.rb', line 1835

def to_jsii
  result = {}
  result.merge!({
    "columnConfiguration" => @column_configuration,
    "connectionConfiguration" => @connection_configuration,
    "databaseEngineType" => @database_engine_type,
    "aclConfiguration" => @acl_configuration,
    "sqlConfiguration" => @sql_configuration,
    "vpcConfiguration" => @vpc_configuration,
  })
  result.compact
end