Interface CfnEndpoint.IGcpMySQLSettingsProperty
Provides information that defines a GCP MySQL endpoint.
Namespace: Amazon.CDK.AWS.DMS
Assembly: Amazon.CDK.AWS.DMS.dll
Syntax (csharp)
public interface IGcpMySQLSettingsProperty
Syntax (vb)
Public Interface IGcpMySQLSettingsProperty
Remarks
This information includes the output format of records applied to the endpoint and details of transaction and control table data information. These settings are much the same as the settings for any MySQL-compatible endpoint. For more information, see Extra connection attributes when using MySQL as a source 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 gcpMySQLSettingsProperty = new GcpMySQLSettingsProperty {
AfterConnectScript = "afterConnectScript",
CleanSourceMetadataOnMismatch = false,
DatabaseName = "databaseName",
EventsPollInterval = 123,
MaxFileSize = 123,
ParallelLoadThreads = 123,
Password = "password",
Port = 123,
SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
SecretsManagerSecretId = "secretsManagerSecretId",
ServerName = "serverName",
ServerTimezone = "serverTimezone",
Username = "username"
};
Synopsis
Properties
AfterConnectScript | Specifies a script to run immediately after AWS DMS connects to the endpoint. |
CleanSourceMetadataOnMismatch | Adjusts the behavior of AWS DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. |
DatabaseName | Database name for the endpoint. |
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. |
Password | Endpoint connection password. |
Port | The port used by the endpoint 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 |
ServerName | Endpoint TCP port. |
ServerTimezone | Specifies the time zone for the source MySQL database. Don't enclose time zones in single quotation marks. |
Username | Endpoint connection user name. |
Properties
AfterConnectScript
Specifies a script to run immediately after AWS DMS connects to the endpoint.
virtual string AfterConnectScript { get; }
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
Adjusts the behavior of AWS DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster.
virtual object CleanSourceMetadataOnMismatch { get; }
Property Value
System.Object
Remarks
If you need AWS DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false
.
DatabaseName
Database name for the endpoint.
virtual string DatabaseName { get; }
Property Value
System.String
Remarks
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 AWS DMS task.
EventsPollInterval
Specifies how often to check the binary log for new changes/events when the database is idle.
virtual Nullable<double> EventsPollInterval { get; }
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.
virtual Nullable<double> MaxFileSize { get; }
Property Value
System.Nullable<System.Double>
Remarks
ParallelLoadThreads
Improves performance when loading data into the MySQL-compatible target database.
virtual Nullable<double> ParallelLoadThreads { get; }
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
Password
Endpoint connection password.
virtual string Password { get; }
Property Value
System.String
Remarks
Port
The port used by the endpoint database.
virtual Nullable<double> Port { get; }
Property Value
System.Nullable<System.Double>
Remarks
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.
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.
virtual string SecretsManagerAccessRoleArn { get; }
Property Value
System.String
Remarks
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
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.
virtual string SecretsManagerSecretId { get; }
Property Value
System.String
Remarks
ServerName
Endpoint TCP port.
virtual string ServerName { get; }
Property Value
System.String
Remarks
ServerTimezone
Specifies the time zone for the source MySQL database. Don't enclose time zones in single quotation marks.
virtual string ServerTimezone { get; }
Property Value
System.String
Remarks
Example: serverTimezone=US/Pacific;
Username
Endpoint connection user name.
virtual string Username { get; }
Property Value
System.String