Class CfnEndpoint.MySqlSettingsProperty
Provides information that defines a MySQL endpoint.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.DMS
Assembly: Amazon.CDK.AWS.DMS.dll
Syntax (csharp)
public class MySqlSettingsProperty : Object, CfnEndpoint.IMySqlSettingsProperty
Syntax (vb)
Public Class MySqlSettingsProperty
Inherits Object
Implements CfnEndpoint.IMySqlSettingsProperty
Remarks
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 .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DMS;
var mySqlSettingsProperty = new MySqlSettingsProperty {
AfterConnectScript = "afterConnectScript",
CleanSourceMetadataOnMismatch = false,
EventsPollInterval = 123,
MaxFileSize = 123,
ParallelLoadThreads = 123,
SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
SecretsManagerSecretId = "secretsManagerSecretId",
ServerTimezone = "serverTimezone",
TargetDbType = "targetDbType"
};
Synopsis
Constructors
MySqlSettingsProperty() |
Properties
AfterConnectScript | Specifies a script to run immediately after AWS DMS connects to the endpoint. |
CleanSourceMetadataOnMismatch | Cleans and recreates table metadata information on the replication instance when a mismatch occurs. |
EventsPollInterval | Specifies how often to check the binary log for new changes/events when the database is idle. |
MaxFileSize | Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database. |
ParallelLoadThreads | Improves performance when loading data into the MySQL-compatible target database. |
SecretsManagerAccessRoleArn | 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 |
SecretsManagerSecretId | The full ARN, partial ARN, or display name of the |
ServerTimezone | Specifies the time zone for the source MySQL database. |
TargetDbType | Specifies where to migrate source tables on the target, either to a single database or multiple databases. |
Constructors
MySqlSettingsProperty()
public MySqlSettingsProperty()
Properties
AfterConnectScript
Specifies a script to run immediately after AWS DMS connects to the endpoint.
public string AfterConnectScript { get; set; }
Property Value
System.String
Remarks
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
Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
public object CleanSourceMetadataOnMismatch { get; set; }
Property Value
System.Object
Remarks
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
Specifies how often to check the binary log for new changes/events when the database is idle.
public Nullable<double> EventsPollInterval { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
The default is five seconds.
Example: eventsPollInterval=5;
In the example, AWS DMS checks for changes in the binary logs every five seconds.
MaxFileSize
Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
public Nullable<double> MaxFileSize { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
ParallelLoadThreads
Improves performance when loading data into the MySQL-compatible target database.
public Nullable<double> ParallelLoadThreads { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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
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
.
public string SecretsManagerAccessRoleArn { get; set; }
Property Value
System.String
Remarks
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
The full ARN, partial ARN, or display name of the SecretsManagerSecret
that contains the MySQL endpoint connection details.
public string SecretsManagerSecretId { get; set; }
Property Value
System.String
Remarks
ServerTimezone
Specifies the time zone for the source MySQL database.
public string ServerTimezone { get; set; }
Property Value
System.String
Remarks
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
TargetDbType
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
public string TargetDbType { get; set; }
Property Value
System.String
Remarks
If you specify SPECIFIC_DATABASE
, specify the database name using the DatabaseName
parameter of the Endpoint
object.
Example: targetDbType=MULTIPLE_DATABASES