Interface CfnDataSource.IConnectionConfigurationProperty

Provides the configuration information that's required to connect to a database.

Namespace: Amazon.CDK.AWS.Kendra

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IConnectionConfigurationProperty

Syntax (vb)

Public Interface IConnectionConfigurationProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;

var connectionConfigurationProperty = new ConnectionConfigurationProperty {
    DatabaseHost = "databaseHost",
    DatabaseName = "databaseName",
    DatabasePort = 123,
    SecretArn = "secretArn",
    TableName = "tableName"
};

Synopsis

Properties

DatabaseHost	The name of the host for the database.
DatabaseName	The name of the database containing the document data.
DatabasePort	The port that the database uses for connections.
SecretArn	The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that stores the credentials.
TableName	The name of the table that contains the document data.

Properties

DatabaseHost

The name of the host for the database.

string DatabaseHost { get; }

Property Value

System.String

Remarks

Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-connectionconfiguration.html#cfn-kendra-datasource-connectionconfiguration-databasehost

DatabaseName

The name of the database containing the document data.

string DatabaseName { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-connectionconfiguration.html#cfn-kendra-datasource-connectionconfiguration-databasename

DatabasePort

The port that the database uses for connections.

double DatabasePort { get; }

Property Value

System.Double

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-connectionconfiguration.html#cfn-kendra-datasource-connectionconfiguration-databaseport

SecretArn

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that stores the credentials.

string SecretArn { get; }

Property Value

System.String

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-connectionconfiguration.html#cfn-kendra-datasource-connectionconfiguration-secretarn

TableName

The name of the table that contains the document data.

string TableName { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-connectionconfiguration.html#cfn-kendra-datasource-connectionconfiguration-tablename