AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Settings in JSON format for the source GCP MySQL endpoint.

Inheritance Hierarchy

System.Object
  Amazon.DatabaseMigrationService.Model.GcpMySQLSettings

Namespace: Amazon.DatabaseMigrationService.Model
Assembly: AWSSDK.DatabaseMigrationService.dll
Version: 3.x.y.z

Syntax

C#
public class GcpMySQLSettings

The GcpMySQLSettings type exposes the following members

Constructors

NameDescription
Public Method GcpMySQLSettings()

Properties

NameTypeDescription
Public Property AfterConnectScript System.String

Gets and sets the property 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.

Public Property CleanSourceMetadataOnMismatch System.Boolean

Gets and sets the property 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.

Public Property DatabaseName System.String

Gets and sets the property 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.

Public Property EventsPollInterval System.Int32

Gets and sets the property 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.

Public Property MaxFileSize System.Int32

Gets and sets the property MaxFileSize.

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

Example: maxFileSize=512

Public Property ParallelLoadThreads System.Int32

Gets and sets the property 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

Public Property Password System.String

Gets and sets the property Password.

Endpoint connection password.

Public Property Port System.Int32

Gets and sets the property Port.

Endpoint TCP port.

Public Property SecretsManagerAccessRoleArn System.String

Gets and sets the property 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.

Public Property SecretsManagerSecretId System.String

Gets and sets the property SecretsManagerSecretId.

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

Public Property ServerName System.String

Gets and sets the property ServerName.

The MySQL host name.

Public Property ServerTimezone System.String

Gets and sets the property ServerTimezone.

Specifies the time zone for the source MySQL database.

Example: serverTimezone=US/Pacific;

Note: Do not enclose time zones in single quotes.

Public Property TargetDbType Amazon.DatabaseMigrationService.TargetDbType

Gets and sets the property TargetDbType.

Specifies where to migrate source tables on the target, either to a single database or multiple databases.

Example: targetDbType=MULTIPLE_DATABASES

Public Property Username System.String

Gets and sets the property Username.

Endpoint connection user name.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5