Package software.amazon.awscdk.services.kendra

Interface CfnDataSource.ConnectionConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.ConnectionConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(Stable)
public static interface CfnDataSource.ConnectionConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kendra.*;
 ConnectionConfigurationProperty connectionConfigurationProperty = ConnectionConfigurationProperty.builder()
         .databaseHost("databaseHost")
         .databaseName("databaseName")
         .databasePort(123)
         .secretArn("secretArn")
         .tableName("tableName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataSource.ConnectionConfigurationProperty.Builder	A builder for CfnDataSource.ConnectionConfigurationProperty
static final class	CfnDataSource.ConnectionConfigurationProperty.Jsii$Proxy	An implementation for CfnDataSource.ConnectionConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.ConnectionConfigurationProperty.Builder	builder()
String	getDatabaseHost()	The name of the host for the database.
String	getDatabaseName()	The name of the database containing the document data.
Number	getDatabasePort()	The port that the database uses for connections.
String	getSecretArn()	The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that stores the credentials.
String	getTableName()	The name of the table that contains the document data.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatabaseHost

@Stability(Stable)
@NotNull
String getDatabaseHost()

The name of the host for the database.

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

See Also:

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

getDatabaseName

@Stability(Stable)
@NotNull
String getDatabaseName()

The name of the database containing the document data.

See Also:

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

getDatabasePort

@Stability(Stable)
@NotNull
Number getDatabasePort()

The port that the database uses for connections.

See Also:

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

getSecretArn

@Stability(Stable)
@NotNull
String getSecretArn()

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

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 Also:

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

getTableName

@Stability(Stable)
@NotNull
String getTableName()

The name of the table that contains the document data.

See Also:

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

builder

@Stability(Stable)
static CfnDataSource.ConnectionConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.ConnectionConfigurationProperty.Builder of CfnDataSource.ConnectionConfigurationProperty