Package software.amazon.awscdk.services.dms

Interface CfnEndpoint.MySqlSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpoint.MySqlSettingsProperty.Jsii$Proxy

Enclosing class:

CfnEndpoint

@Stability(Stable)
public static interface CfnEndpoint.MySqlSettingsProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.dms.*;
 MySqlSettingsProperty mySqlSettingsProperty = MySqlSettingsProperty.builder()
         .afterConnectScript("afterConnectScript")
         .cleanSourceMetadataOnMismatch(false)
         .eventsPollInterval(123)
         .maxFileSize(123)
         .parallelLoadThreads(123)
         .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
         .secretsManagerSecretId("secretsManagerSecretId")
         .serverTimezone("serverTimezone")
         .targetDbType("targetDbType")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEndpoint.MySqlSettingsProperty.Builder	A builder for CfnEndpoint.MySqlSettingsProperty
static final class	CfnEndpoint.MySqlSettingsProperty.Jsii$Proxy	An implementation for CfnEndpoint.MySqlSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnEndpoint.MySqlSettingsProperty.Builder	builder()
default String	getAfterConnectScript()	Specifies a script to run immediately after AWS DMS connects to the endpoint.
default Object	getCleanSourceMetadataOnMismatch()	Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
default Number	getEventsPollInterval()	Specifies how often to check the binary log for new changes/events when the database is idle.
default Number	getMaxFileSize()	Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
default Number	getParallelLoadThreads()	Improves performance when loading data into the MySQL-compatible target database.
default String	getSecretsManagerAccessRoleArn()	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 .
default String	getSecretsManagerSecretId()	The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
default String	getServerTimezone()	Specifies the time zone for the source MySQL database.
default String	getTargetDbType()	Specifies where to migrate source tables on the target, either to a single database or multiple databases.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAfterConnectScript

@Stability(Stable)
@Nullable
default String getAfterConnectScript()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-afterconnectscript

getCleanSourceMetadataOnMismatch

@Stability(Stable)
@Nullable
default Object getCleanSourceMetadataOnMismatch()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-cleansourcemetadataonmismatch

getEventsPollInterval

@Stability(Stable)
@Nullable
default Number getEventsPollInterval()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-eventspollinterval

getMaxFileSize

@Stability(Stable)
@Nullable
default Number getMaxFileSize()

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

Example: maxFileSize=512

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-maxfilesize

getParallelLoadThreads

@Stability(Stable)
@Nullable
default Number getParallelLoadThreads()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-parallelloadthreads

getSecretsManagerAccessRoleArn

@Stability(Stable)
@Nullable
default String getSecretsManagerAccessRoleArn()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-secretsmanageraccessrolearn

getSecretsManagerSecretId

@Stability(Stable)
@Nullable
default String getSecretsManagerSecretId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-secretsmanagersecretid

getServerTimezone

@Stability(Stable)
@Nullable
default String getServerTimezone()

Specifies the time zone for the source MySQL database.

Example: serverTimezone=US/Pacific;

Note: Do not enclose time zones in single quotes.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-servertimezone

getTargetDbType

@Stability(Stable)
@Nullable
default String getTargetDbType()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-targetdbtype

builder

@Stability(Stable)
static CfnEndpoint.MySqlSettingsProperty.Builder builder()

Returns:

a CfnEndpoint.MySqlSettingsProperty.Builder of CfnEndpoint.MySqlSettingsProperty