MySqlSettings

Provides information that defines a MySQL endpoint.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Specifies a script to run immediately after DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.

Link copied to clipboard

This attribute allows you to specify the authentication method as "iam auth".

Link copied to clipboard

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.

Link copied to clipboard

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 the CreateEndpoint or ModifyEndpoint API call. Specifying DatabaseName 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 DMS task.

Link copied to clipboard

Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.

Link copied to clipboard

Sets the client statement timeout (in seconds) for a MySQL source endpoint.

Link copied to clipboard

Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.

Link copied to clipboard

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.

Link copied to clipboard

Endpoint connection password.

Link copied to clipboard
val port: Int?

Endpoint TCP port.

Link copied to clipboard

The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the MySQL endpoint.

Link copied to clipboard

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MySQL endpoint connection details.

Link copied to clipboard

The host name of the endpoint database.

Link copied to clipboard

Specifies the time zone for the source MySQL database.

Link copied to clipboard

The IAM role you can use to authenticate when connecting to your endpoint. Ensure to include iam:PassRole and rds-db:connect actions in permission policy.

Link copied to clipboard

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 the DatabaseName parameter of the Endpoint object.

Link copied to clipboard

Endpoint connection user name.

Functions

Link copied to clipboard
inline fun copy(block: MySqlSettings.Builder.() -> Unit = {}): MySqlSettings
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String