class Aws::Kendra::Types::DatabaseConfiguration

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

@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
      },
    }

@!attribute [rw] database_engine_type

The type of database engine that runs the database.
@return [String]

@!attribute [rw] connection_configuration

The information necessary to connect to a database.
@return [Types::ConnectionConfiguration]

@!attribute [rw] vpc_configuration

Provides information for connecting to an Amazon VPC.
@return [Types::DataSourceVpcConfiguration]

@!attribute [rw] column_configuration

Information about where the index should get the document
information from the database.
@return [Types::ColumnConfiguration]

@!attribute [rw] acl_configuration

Information about the database column that provides information for
user context filtering.
@return [Types::AclConfiguration]

@!attribute [rw] sql_configuration

Provides information about how Amazon Kendra uses quote marks around
SQL identifiers when querying a database data source.
@return [Types::SqlConfiguration]

@see docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DatabaseConfiguration AWS API Documentation

Constants

SENSITIVE