ConnectionConfiguration
Provides the configuration information that's required to connect to a database.
Contents
- DatabaseHost
-
The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 253.
Required: Yes
- DatabaseName
-
The name of the database containing the document data.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[a-zA-Z][a-zA-Z0-9_]*$Required: Yes
- DatabasePort
-
The port that the database uses for connections.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65535.
Required: Yes
- SecretArn
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1284.
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}Required: Yes
- TableName
-
The name of the table that contains the document data.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[a-zA-Z][a-zA-Z0-9_]*$Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
