interface MySqlSettingsProperty

Language	Type name
.NET	`Amazon.CDK.AWS.DMS.CfnEndpoint.MySqlSettingsProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsdms#CfnEndpoint_MySqlSettingsProperty`
Java	`software.amazon.awscdk.services.dms.CfnEndpoint.MySqlSettingsProperty`
Python	`aws_cdk.aws_dms.CfnEndpoint.MySqlSettingsProperty`
TypeScript	`aws-cdk-lib` » `aws_dms` » `CfnEndpoint` » `MySqlSettingsProperty`

Provides information that defines a MySQL endpoint.

This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For information about other available settings, see Extra connection attributes when using MySQL as a source for AWS DMS and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS in the AWS Database Migration Service User Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dms as dms } from 'aws-cdk-lib';
const mySqlSettingsProperty: dms.CfnEndpoint.MySqlSettingsProperty = {
  afterConnectScript: 'afterConnectScript',
  cleanSourceMetadataOnMismatch: false,
  eventsPollInterval: 123,
  maxFileSize: 123,
  parallelLoadThreads: 123,
  secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
  secretsManagerSecretId: 'secretsManagerSecretId',
  serverTimezone: 'serverTimezone',
  targetDbType: 'targetDbType',
};

Properties

Name	Type	Description
afterConnectScript?	`string`	Specifies a script to run immediately after AWS DMS connects to the endpoint.
cleanSourceMetadataOnMismatch?	`boolean \|` `IResolvable`	Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
eventsPollInterval?	`number`	Specifies how often to check the binary log for new changes/events when the database is idle.
maxFileSize?	`number`	Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
parallelLoadThreads?	`number`	Improves performance when loading data into the MySQL-compatible target database.
secretsManagerAccessRoleArn?	`string`	The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret` .
secretsManagerSecretId?	`string`	The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details.
serverTimezone?	`string`	Specifies the time zone for the source MySQL database.
targetDbType?	`string`	Specifies where to migrate source tables on the target, either to a single database or multiple databases.

afterConnectScript?

Type: string (optional)

Specifies a script to run immediately after AWS 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.

cleanSourceMetadataOnMismatch?

Type: boolean | IResolvable (optional)

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.

eventsPollInterval?

Type: number (optional)

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

maxFileSize?

Type: number (optional)

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

Example: maxFileSize=512

parallelLoadThreads?

Type: number (optional)

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

secretsManagerAccessRoleArn?

Type: string (optional)

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS 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 , the corresponding SecretsManagerAccessRoleArn , and the SecretsManagerSecretId that is required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide .

secretsManagerSecretId?

Type: string (optional)

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

serverTimezone?

Type: string (optional)

Specifies the time zone for the source MySQL database.

Example: serverTimezone=US/Pacific;

Note: Do not enclose time zones in single quotes.

targetDbType?

Type: string (optional)

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