AWS SDK for C++  1.9.1
AWS SDK for C++
Public Member Functions | List of all members
Aws::kendra::Model::ConnectionConfiguration Class Reference

#include <ConnectionConfiguration.h>

Public Member Functions

 ConnectionConfiguration ()
 
 ConnectionConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
ConnectionConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetDatabaseHost () const
 
bool DatabaseHostHasBeenSet () const
 
void SetDatabaseHost (const Aws::String &value)
 
void SetDatabaseHost (Aws::String &&value)
 
void SetDatabaseHost (const char *value)
 
ConnectionConfigurationWithDatabaseHost (const Aws::String &value)
 
ConnectionConfigurationWithDatabaseHost (Aws::String &&value)
 
ConnectionConfigurationWithDatabaseHost (const char *value)
 
int GetDatabasePort () const
 
bool DatabasePortHasBeenSet () const
 
void SetDatabasePort (int value)
 
ConnectionConfigurationWithDatabasePort (int value)
 
const Aws::StringGetDatabaseName () const
 
bool DatabaseNameHasBeenSet () const
 
void SetDatabaseName (const Aws::String &value)
 
void SetDatabaseName (Aws::String &&value)
 
void SetDatabaseName (const char *value)
 
ConnectionConfigurationWithDatabaseName (const Aws::String &value)
 
ConnectionConfigurationWithDatabaseName (Aws::String &&value)
 
ConnectionConfigurationWithDatabaseName (const char *value)
 
const Aws::StringGetTableName () const
 
bool TableNameHasBeenSet () const
 
void SetTableName (const Aws::String &value)
 
void SetTableName (Aws::String &&value)
 
void SetTableName (const char *value)
 
ConnectionConfigurationWithTableName (const Aws::String &value)
 
ConnectionConfigurationWithTableName (Aws::String &&value)
 
ConnectionConfigurationWithTableName (const char *value)
 
const Aws::StringGetSecretArn () const
 
bool SecretArnHasBeenSet () const
 
void SetSecretArn (const Aws::String &value)
 
void SetSecretArn (Aws::String &&value)
 
void SetSecretArn (const char *value)
 
ConnectionConfigurationWithSecretArn (const Aws::String &value)
 
ConnectionConfigurationWithSecretArn (Aws::String &&value)
 
ConnectionConfigurationWithSecretArn (const char *value)
 

Detailed Description

Provides the information necessary to connect to a database.

See Also:

AWS API Reference

Definition at line 32 of file ConnectionConfiguration.h.

Constructor & Destructor Documentation

◆ ConnectionConfiguration() [1/2]

Aws::kendra::Model::ConnectionConfiguration::ConnectionConfiguration ( )

◆ ConnectionConfiguration() [2/2]

Aws::kendra::Model::ConnectionConfiguration::ConnectionConfiguration ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ DatabaseHostHasBeenSet()

bool Aws::kendra::Model::ConnectionConfiguration::DatabaseHostHasBeenSet ( ) const
inline

The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

Definition at line 51 of file ConnectionConfiguration.h.

◆ DatabaseNameHasBeenSet()

bool Aws::kendra::Model::ConnectionConfiguration::DatabaseNameHasBeenSet ( ) const
inline

The name of the database containing the document data.

Definition at line 119 of file ConnectionConfiguration.h.

◆ DatabasePortHasBeenSet()

bool Aws::kendra::Model::ConnectionConfiguration::DatabasePortHasBeenSet ( ) const
inline

The port that the database uses for connections.

Definition at line 98 of file ConnectionConfiguration.h.

◆ GetDatabaseHost()

const Aws::String& Aws::kendra::Model::ConnectionConfiguration::GetDatabaseHost ( ) const
inline

The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

Definition at line 45 of file ConnectionConfiguration.h.

◆ GetDatabaseName()

const Aws::String& Aws::kendra::Model::ConnectionConfiguration::GetDatabaseName ( ) const
inline

The name of the database containing the document data.

Definition at line 114 of file ConnectionConfiguration.h.

◆ GetDatabasePort()

int Aws::kendra::Model::ConnectionConfiguration::GetDatabasePort ( ) const
inline

The port that the database uses for connections.

Definition at line 93 of file ConnectionConfiguration.h.

◆ GetSecretArn()

const Aws::String& Aws::kendra::Model::ConnectionConfiguration::GetSecretArn ( ) const
inline

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

Definition at line 203 of file ConnectionConfiguration.h.

◆ GetTableName()

const Aws::String& Aws::kendra::Model::ConnectionConfiguration::GetTableName ( ) const
inline

The name of the table that contains the document data.

Definition at line 155 of file ConnectionConfiguration.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::kendra::Model::ConnectionConfiguration::Jsonize ( ) const

◆ operator=()

ConnectionConfiguration& Aws::kendra::Model::ConnectionConfiguration::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SecretArnHasBeenSet()

bool Aws::kendra::Model::ConnectionConfiguration::SecretArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

Definition at line 215 of file ConnectionConfiguration.h.

◆ SetDatabaseHost() [1/3]

void Aws::kendra::Model::ConnectionConfiguration::SetDatabaseHost ( Aws::String &&  value)
inline

The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

Definition at line 63 of file ConnectionConfiguration.h.

◆ SetDatabaseHost() [2/3]

void Aws::kendra::Model::ConnectionConfiguration::SetDatabaseHost ( const Aws::String value)
inline

The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

Definition at line 57 of file ConnectionConfiguration.h.

◆ SetDatabaseHost() [3/3]

void Aws::kendra::Model::ConnectionConfiguration::SetDatabaseHost ( const char *  value)
inline

The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

Definition at line 69 of file ConnectionConfiguration.h.

◆ SetDatabaseName() [1/3]

void Aws::kendra::Model::ConnectionConfiguration::SetDatabaseName ( Aws::String &&  value)
inline

The name of the database containing the document data.

Definition at line 129 of file ConnectionConfiguration.h.

◆ SetDatabaseName() [2/3]

void Aws::kendra::Model::ConnectionConfiguration::SetDatabaseName ( const Aws::String value)
inline

The name of the database containing the document data.

Definition at line 124 of file ConnectionConfiguration.h.

◆ SetDatabaseName() [3/3]

void Aws::kendra::Model::ConnectionConfiguration::SetDatabaseName ( const char *  value)
inline

The name of the database containing the document data.

Definition at line 134 of file ConnectionConfiguration.h.

◆ SetDatabasePort()

void Aws::kendra::Model::ConnectionConfiguration::SetDatabasePort ( int  value)
inline

The port that the database uses for connections.

Definition at line 103 of file ConnectionConfiguration.h.

◆ SetSecretArn() [1/3]

void Aws::kendra::Model::ConnectionConfiguration::SetSecretArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

Definition at line 239 of file ConnectionConfiguration.h.

◆ SetSecretArn() [2/3]

void Aws::kendra::Model::ConnectionConfiguration::SetSecretArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

Definition at line 227 of file ConnectionConfiguration.h.

◆ SetSecretArn() [3/3]

void Aws::kendra::Model::ConnectionConfiguration::SetSecretArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

Definition at line 251 of file ConnectionConfiguration.h.

◆ SetTableName() [1/3]

void Aws::kendra::Model::ConnectionConfiguration::SetTableName ( Aws::String &&  value)
inline

The name of the table that contains the document data.

Definition at line 170 of file ConnectionConfiguration.h.

◆ SetTableName() [2/3]

void Aws::kendra::Model::ConnectionConfiguration::SetTableName ( const Aws::String value)
inline

The name of the table that contains the document data.

Definition at line 165 of file ConnectionConfiguration.h.

◆ SetTableName() [3/3]

void Aws::kendra::Model::ConnectionConfiguration::SetTableName ( const char *  value)
inline

The name of the table that contains the document data.

Definition at line 175 of file ConnectionConfiguration.h.

◆ TableNameHasBeenSet()

bool Aws::kendra::Model::ConnectionConfiguration::TableNameHasBeenSet ( ) const
inline

The name of the table that contains the document data.

Definition at line 160 of file ConnectionConfiguration.h.

◆ WithDatabaseHost() [1/3]

ConnectionConfiguration& Aws::kendra::Model::ConnectionConfiguration::WithDatabaseHost ( Aws::String &&  value)
inline

The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

Definition at line 81 of file ConnectionConfiguration.h.

◆ WithDatabaseHost() [2/3]

ConnectionConfiguration& Aws::kendra::Model::ConnectionConfiguration::WithDatabaseHost ( const Aws::String value)
inline

The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

Definition at line 75 of file ConnectionConfiguration.h.

◆ WithDatabaseHost() [3/3]

ConnectionConfiguration& Aws::kendra::Model::ConnectionConfiguration::WithDatabaseHost ( const char *  value)
inline

The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

Definition at line 87 of file ConnectionConfiguration.h.

◆ WithDatabaseName() [1/3]

ConnectionConfiguration& Aws::kendra::Model::ConnectionConfiguration::WithDatabaseName ( Aws::String &&  value)
inline

The name of the database containing the document data.

Definition at line 144 of file ConnectionConfiguration.h.

◆ WithDatabaseName() [2/3]

ConnectionConfiguration& Aws::kendra::Model::ConnectionConfiguration::WithDatabaseName ( const Aws::String value)
inline

The name of the database containing the document data.

Definition at line 139 of file ConnectionConfiguration.h.

◆ WithDatabaseName() [3/3]

ConnectionConfiguration& Aws::kendra::Model::ConnectionConfiguration::WithDatabaseName ( const char *  value)
inline

The name of the database containing the document data.

Definition at line 149 of file ConnectionConfiguration.h.

◆ WithDatabasePort()

ConnectionConfiguration& Aws::kendra::Model::ConnectionConfiguration::WithDatabasePort ( int  value)
inline

The port that the database uses for connections.

Definition at line 108 of file ConnectionConfiguration.h.

◆ WithSecretArn() [1/3]

ConnectionConfiguration& Aws::kendra::Model::ConnectionConfiguration::WithSecretArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

Definition at line 275 of file ConnectionConfiguration.h.

◆ WithSecretArn() [2/3]

ConnectionConfiguration& Aws::kendra::Model::ConnectionConfiguration::WithSecretArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

Definition at line 263 of file ConnectionConfiguration.h.

◆ WithSecretArn() [3/3]

ConnectionConfiguration& Aws::kendra::Model::ConnectionConfiguration::WithSecretArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

Definition at line 287 of file ConnectionConfiguration.h.

◆ WithTableName() [1/3]

ConnectionConfiguration& Aws::kendra::Model::ConnectionConfiguration::WithTableName ( Aws::String &&  value)
inline

The name of the table that contains the document data.

Definition at line 185 of file ConnectionConfiguration.h.

◆ WithTableName() [2/3]

ConnectionConfiguration& Aws::kendra::Model::ConnectionConfiguration::WithTableName ( const Aws::String value)
inline

The name of the table that contains the document data.

Definition at line 180 of file ConnectionConfiguration.h.

◆ WithTableName() [3/3]

ConnectionConfiguration& Aws::kendra::Model::ConnectionConfiguration::WithTableName ( const char *  value)
inline

The name of the table that contains the document data.

Definition at line 190 of file ConnectionConfiguration.h.


The documentation for this class was generated from the following file: