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();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDataSource.ConnectionConfigurationProperty
static final class
An implementation forCfnDataSource.ConnectionConfigurationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The name of the host for the database.The name of the database containing the document data.The port that the database uses for connections.The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager .The name of the table that contains the document data.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDatabaseHost
The name of the host for the database.Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
-
getDatabaseName
The name of the database containing the document data. -
getDatabasePort
The port that the database uses for connections. -
getSecretArn
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.
-
getTableName
The name of the table that contains the document data. -
builder
-