Skip to content

/AWS1/CL_DMGMYSQLSETTINGS

Provides information that defines a MySQL endpoint.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_afterconnectscript TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

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.

For this parameter, provide the code of the script itself, not the name of a file containing the script.

iv_cleansourcemetonmismatch TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

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.

iv_databasename TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

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.

iv_eventspollinterval TYPE /AWS1/DMGINTEGEROPTIONAL /AWS1/DMGINTEGEROPTIONAL

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, DMS checks for changes in the binary logs every five seconds.

iv_targetdbtype TYPE /AWS1/DMGTARGETDBTYPE /AWS1/DMGTARGETDBTYPE

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.

Example: targetDbType=MULTIPLE_DATABASES

iv_maxfilesize TYPE /AWS1/DMGINTEGEROPTIONAL /AWS1/DMGINTEGEROPTIONAL

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

Example: maxFileSize=512

iv_parallelloadthreads TYPE /AWS1/DMGINTEGEROPTIONAL /AWS1/DMGINTEGEROPTIONAL

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

iv_password TYPE /AWS1/DMGSECRETSTRING /AWS1/DMGSECRETSTRING

Endpoint connection password.

iv_port TYPE /AWS1/DMGINTEGEROPTIONAL /AWS1/DMGINTEGEROPTIONAL

Endpoint TCP port.

iv_servername TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

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.

iv_servertimezone TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

Specifies the time zone for the source MySQL database.

Example: serverTimezone=US/Pacific;

Note: Do not enclose time zones in single quotes.

iv_username TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

Endpoint connection user name.

iv_secretsmanageraccrolearn TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

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.

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 for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

iv_secretsmanagersecretid TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

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

iv_executetimeout TYPE /AWS1/DMGINTEGEROPTIONAL /AWS1/DMGINTEGEROPTIONAL

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

iv_serviceaccessrolearn TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

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.

iv_authenticationmethod TYPE /AWS1/DMGMYSQLAUTHNTCTNMETHOD /AWS1/DMGMYSQLAUTHNTCTNMETHOD

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

Queryable Attributes

AfterConnectScript

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.

For this parameter, provide the code of the script itself, not the name of a file containing the script.

Accessible with the following methods

Method Description
GET_AFTERCONNECTSCRIPT() Getter for AFTERCONNECTSCRIPT, with configurable default
ASK_AFTERCONNECTSCRIPT() Getter for AFTERCONNECTSCRIPT w/ exceptions if field has no
HAS_AFTERCONNECTSCRIPT() Determine if AFTERCONNECTSCRIPT has a value

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.

Accessible with the following methods

Method Description
GET_CLEANSOURCEMETONMISMATCH() Getter for CLEANSOURCEMETONMISMATCH, with configurable defau
ASK_CLEANSOURCEMETONMISMATCH() Getter for CLEANSOURCEMETONMISMATCH w/ exceptions if field h
HAS_CLEANSOURCEMETONMISMATCH() Determine if CLEANSOURCEMETONMISMATCH has a value

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 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.

Accessible with the following methods

Method Description
GET_DATABASENAME() Getter for DATABASENAME, with configurable default
ASK_DATABASENAME() Getter for DATABASENAME w/ exceptions if field has no value
HAS_DATABASENAME() Determine if DATABASENAME has a value

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, DMS checks for changes in the binary logs every five seconds.

Accessible with the following methods

Method Description
GET_EVENTSPOLLINTERVAL() Getter for EVENTSPOLLINTERVAL, with configurable default
ASK_EVENTSPOLLINTERVAL() Getter for EVENTSPOLLINTERVAL w/ exceptions if field has no
HAS_EVENTSPOLLINTERVAL() Determine if EVENTSPOLLINTERVAL has a value

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

Example: targetDbType=MULTIPLE_DATABASES

Accessible with the following methods

Method Description
GET_TARGETDBTYPE() Getter for TARGETDBTYPE, with configurable default
ASK_TARGETDBTYPE() Getter for TARGETDBTYPE w/ exceptions if field has no value
HAS_TARGETDBTYPE() Determine if TARGETDBTYPE has a value

MaxFileSize

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

Example: maxFileSize=512

Accessible with the following methods

Method Description
GET_MAXFILESIZE() Getter for MAXFILESIZE, with configurable default
ASK_MAXFILESIZE() Getter for MAXFILESIZE w/ exceptions if field has no value
HAS_MAXFILESIZE() Determine if MAXFILESIZE has a value

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

Accessible with the following methods

Method Description
GET_PARALLELLOADTHREADS() Getter for PARALLELLOADTHREADS, with configurable default
ASK_PARALLELLOADTHREADS() Getter for PARALLELLOADTHREADS w/ exceptions if field has no
HAS_PARALLELLOADTHREADS() Determine if PARALLELLOADTHREADS has a value

Password

Endpoint connection password.

Accessible with the following methods

Method Description
GET_PASSWORD() Getter for PASSWORD, with configurable default
ASK_PASSWORD() Getter for PASSWORD w/ exceptions if field has no value
HAS_PASSWORD() Determine if PASSWORD has a value

Port

Endpoint TCP port.

Accessible with the following methods

Method Description
GET_PORT() Getter for PORT, with configurable default
ASK_PORT() Getter for PORT w/ exceptions if field has no value
HAS_PORT() Determine if PORT has a value

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.

Accessible with the following methods

Method Description
GET_SERVERNAME() Getter for SERVERNAME, with configurable default
ASK_SERVERNAME() Getter for SERVERNAME w/ exceptions if field has no value
HAS_SERVERNAME() Determine if SERVERNAME has a value

ServerTimezone

Specifies the time zone for the source MySQL database.

Example: serverTimezone=US/Pacific;

Note: Do not enclose time zones in single quotes.

Accessible with the following methods

Method Description
GET_SERVERTIMEZONE() Getter for SERVERTIMEZONE, with configurable default
ASK_SERVERTIMEZONE() Getter for SERVERTIMEZONE w/ exceptions if field has no valu
HAS_SERVERTIMEZONE() Determine if SERVERTIMEZONE has a value

Username

Endpoint connection user name.

Accessible with the following methods

Method Description
GET_USERNAME() Getter for USERNAME, with configurable default
ASK_USERNAME() Getter for USERNAME w/ exceptions if field has no value
HAS_USERNAME() Determine if USERNAME has a value

SecretsManagerAccessRoleArn

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.

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 for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

Accessible with the following methods

Method Description
GET_SECRETSMANAGERACCROLEARN() Getter for SECRETSMANAGERACCESSROLEARN, with configurable de
ASK_SECRETSMANAGERACCROLEARN() Getter for SECRETSMANAGERACCESSROLEARN w/ exceptions if fiel
HAS_SECRETSMANAGERACCROLEARN() Determine if SECRETSMANAGERACCESSROLEARN has a value

SecretsManagerSecretId

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

Accessible with the following methods

Method Description
GET_SECRETSMANAGERSECRETID() Getter for SECRETSMANAGERSECRETID, with configurable default
ASK_SECRETSMANAGERSECRETID() Getter for SECRETSMANAGERSECRETID w/ exceptions if field has
HAS_SECRETSMANAGERSECRETID() Determine if SECRETSMANAGERSECRETID has a value

ExecuteTimeout

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

Accessible with the following methods

Method Description
GET_EXECUTETIMEOUT() Getter for EXECUTETIMEOUT, with configurable default
ASK_EXECUTETIMEOUT() Getter for EXECUTETIMEOUT w/ exceptions if field has no valu
HAS_EXECUTETIMEOUT() Determine if EXECUTETIMEOUT has a value

ServiceAccessRoleArn

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.

Accessible with the following methods

Method Description
GET_SERVICEACCESSROLEARN() Getter for SERVICEACCESSROLEARN, with configurable default
ASK_SERVICEACCESSROLEARN() Getter for SERVICEACCESSROLEARN w/ exceptions if field has n
HAS_SERVICEACCESSROLEARN() Determine if SERVICEACCESSROLEARN has a value

AuthenticationMethod

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

Accessible with the following methods

Method Description
GET_AUTHENTICATIONMETHOD() Getter for AUTHENTICATIONMETHOD, with configurable default
ASK_AUTHENTICATIONMETHOD() Getter for AUTHENTICATIONMETHOD w/ exceptions if field has n
HAS_AUTHENTICATIONMETHOD() Determine if AUTHENTICATIONMETHOD has a value