MySQLSettings
Provides information that defines a MySQL endpoint.
Contents
- AfterConnectScript
-
Specifies a script to run immediately after Amazon DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
For this parameter, provide the code of the script itself, not the name of a file containing the script.
Type: String
Required: No
- CleanSourceMetadataOnMismatch
-
Cleans and recreates table metadata information on the replication instance when a mismatch occurs. For example, in a situation where running an alter DDL on the table could result in different information about the table cached in the replication instance.
Type: Boolean
Required: No
- DatabaseName
-
Database name for the endpoint. For a MySQL source or target endpoint, don't explicitly specify the database using the
DatabaseName
request parameter on either theCreateEndpoint
orModifyEndpoint
API call. SpecifyingDatabaseName
when you create or modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the Amazon DMS task.Type: String
Required: No
- EventsPollInterval
-
Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.
Example:
eventsPollInterval=5;
In the example, Amazon DMS checks for changes in the binary logs every five seconds.
Type: Integer
Required: No
- ExecuteTimeout
-
Sets the client statement timeout (in seconds) for a MySQL source endpoint.
Type: Integer
Required: No
- MaxFileSize
-
Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
Example:
maxFileSize=512
Type: Integer
Required: No
- ParallelLoadThreads
-
Improves performance when loading data into the MySQL-compatible target database. Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one.
Example:
parallelLoadThreads=1
Type: Integer
Required: No
- Password
-
Endpoint connection password.
Type: String
Required: No
- Port
-
Endpoint TCP port.
Type: Integer
Required: No
- SecretsManagerAccessRoleArn
-
The full Amazon Resource Name (ARN) of the IAM role that specifies Amazon DMS as the trusted entity and grants the required permissions to access the value in
SecretsManagerSecret
. The role must allow theiam:PassRole
action.SecretsManagerSecret
has the value of the Amazon Secrets Manager secret that allows access to the MySQL endpoint.Note
You can specify one of two sets of values for these permissions. You can specify the values for this setting and
SecretsManagerSecretId
. Or you can specify clear-text values forUserName
,Password
,ServerName
, andPort
. You can't specify both. For more information on creating thisSecretsManagerSecret
and theSecretsManagerAccessRoleArn
andSecretsManagerSecretId
required to access it, see Using secrets to access Amazon Database Migration Service resources in the Amazon Database Migration Service User Guide.Type: String
Required: No
- SecretsManagerSecretId
-
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret
that contains the MySQL endpoint connection details.Type: String
Required: No
- ServerName
-
The host name of the endpoint database.
For an Amazon RDS MySQL instance, this is the output of DescribeDBInstances, in the
Endpoint.Address
field.For an Aurora MySQL instance, this is the output of DescribeDBClusters, in the
Endpoint
field.Type: String
Required: No
- ServerTimezone
-
Specifies the time zone for the source MySQL database.
Example:
serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
Type: String
Required: No
- TargetDbType
-
Specifies where to migrate source tables on the target, either to a single database or multiple databases. If you specify
SPECIFIC_DATABASE
, specify the database name using theDatabaseName
parameter of theEndpoint
object.Example:
targetDbType=MULTIPLE_DATABASES
Type: String
Valid Values:
specific-database | multiple-databases
Required: No
- Username
-
Endpoint connection user name.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: