Class: AWSCDK::Kendra::CfnDataSource::SqlConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Kendra::CfnDataSource::SqlConfigurationProperty

Defined in:

kendra/cfn_data_source.rb

Overview

Provides information that configures Amazon Kendra to use a SQL database.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sqlconfiguration.html

Instance Attribute Summary

• #query_identifiers_enclosing_option ⇒ String^? readonly

  Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(query_identifiers_enclosing_option: nil) ⇒ SqlConfigurationProperty constructor

  A new instance of SqlConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(query_identifiers_enclosing_option: nil) ⇒ SqlConfigurationProperty

Returns a new instance of SqlConfigurationProperty.

Parameters:

• query_identifiers_enclosing_option (String, nil) (defaults to: nil) —

  Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query.

# File 'kendra/cfn_data_source.rb', line 3624

def initialize(query_identifiers_enclosing_option: nil)
  @query_identifiers_enclosing_option = query_identifiers_enclosing_option
  Jsii::Type.check_type(@query_identifiers_enclosing_option, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "queryIdentifiersEnclosingOption") unless @query_identifiers_enclosing_option.nil?
end

Instance Attribute Details

#query_identifiers_enclosing_option ⇒ String^? (readonly)

Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query.

You can set the value to DOUBLE_QUOTES or NONE .

By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.

PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's case.

For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sqlconfiguration.html#cfn-kendra-datasource-sqlconfiguration-queryidentifiersenclosingoption

# File 'kendra/cfn_data_source.rb', line 3641

def query_identifiers_enclosing_option
  @query_identifiers_enclosing_option
end

Class Method Details

.jsii_properties ⇒ Object

# File 'kendra/cfn_data_source.rb', line 3643

def self.jsii_properties
  {
    :query_identifiers_enclosing_option => "queryIdentifiersEnclosingOption",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'kendra/cfn_data_source.rb', line 3649

def to_jsii
  result = {}
  result.merge!({
    "queryIdentifiersEnclosingOption" => @query_identifiers_enclosing_option,
  })
  result.compact
end