Class: Aws::Kendra::Types::DatabaseConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

Note:

When making an API call, you may pass DatabaseConfiguration data as a hash:

{
  database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
  connection_configuration: { # required
    database_host: "DatabaseHost", # required
    database_port: 1, # required
    database_name: "DatabaseName", # required
    table_name: "TableName", # required
    secret_arn: "SecretArn", # required
  },
  vpc_configuration: {
    subnet_ids: ["SubnetId"], # required
    security_group_ids: ["VpcSecurityGroupId"], # required
  },
  column_configuration: { # required
    document_id_column_name: "ColumnName", # required
    document_data_column_name: "ColumnName", # required
    document_title_column_name: "ColumnName",
    field_mappings: [
      {
        data_source_field_name: "DataSourceFieldName", # required
        date_field_format: "DataSourceDateFieldFormat",
        index_field_name: "IndexFieldName", # required
      },
    ],
    change_detecting_columns: ["ColumnName"], # required
  },
  acl_configuration: {
    allowed_groups_column_name: "ColumnName", # required
  },
  sql_configuration: {
    query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
  },
}

Provides the information necessary to connect a database to an index.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#acl_configurationTypes::AclConfiguration

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


2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
# File 'lib/aws-sdk-kendra/types.rb', line 2694

class DatabaseConfiguration < Struct.new(
  :database_engine_type,
  :connection_configuration,
  :vpc_configuration,
  :column_configuration,
  :acl_configuration,
  :sql_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#column_configurationTypes::ColumnConfiguration

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


2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
# File 'lib/aws-sdk-kendra/types.rb', line 2694

class DatabaseConfiguration < Struct.new(
  :database_engine_type,
  :connection_configuration,
  :vpc_configuration,
  :column_configuration,
  :acl_configuration,
  :sql_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#connection_configurationTypes::ConnectionConfiguration

The information necessary to connect to a database.


2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
# File 'lib/aws-sdk-kendra/types.rb', line 2694

class DatabaseConfiguration < Struct.new(
  :database_engine_type,
  :connection_configuration,
  :vpc_configuration,
  :column_configuration,
  :acl_configuration,
  :sql_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#database_engine_typeString

The type of database engine that runs the database.

Returns:

  • (String)

2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
# File 'lib/aws-sdk-kendra/types.rb', line 2694

class DatabaseConfiguration < Struct.new(
  :database_engine_type,
  :connection_configuration,
  :vpc_configuration,
  :column_configuration,
  :acl_configuration,
  :sql_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#sql_configurationTypes::SqlConfiguration

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


2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
# File 'lib/aws-sdk-kendra/types.rb', line 2694

class DatabaseConfiguration < Struct.new(
  :database_engine_type,
  :connection_configuration,
  :vpc_configuration,
  :column_configuration,
  :acl_configuration,
  :sql_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configurationTypes::DataSourceVpcConfiguration

Provides information for connecting to an Amazon VPC.


2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
# File 'lib/aws-sdk-kendra/types.rb', line 2694

class DatabaseConfiguration < Struct.new(
  :database_engine_type,
  :connection_configuration,
  :vpc_configuration,
  :column_configuration,
  :acl_configuration,
  :sql_configuration)
  SENSITIVE = []
  include Aws::Structure
end