Package software.amazon.awssdk.services.databasemigration.model

Interface MySQLSettings.Builder

All Superinterfaces:
Buildable, CopyableBuilder<MySQLSettings.Builder,MySQLSettings>, SdkBuilder<MySQLSettings.Builder,MySQLSettings>, SdkPojo
Enclosing class:
MySQLSettings
public static interface MySQLSettings.Builder extends SdkPojo, CopyableBuilder<MySQLSettings.Builder,MySQLSettings>

  • Method Details

    • afterConnectScript

      MySQLSettings.Builder afterConnectScript(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cleanSourceMetadataOnMismatch

      MySQLSettings.Builder cleanSourceMetadataOnMismatch(Boolean 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • databaseName

      MySQLSettings.Builder databaseName(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventsPollInterval

      MySQLSettings.Builder eventsPollInterval(Integer 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetDbType

      MySQLSettings.Builder targetDbType(String targetDbType)

      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

      Parameters:
      targetDbType - 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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • targetDbType

      MySQLSettings.Builder targetDbType(TargetDbType targetDbType)

      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

      Parameters:
      targetDbType - 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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxFileSize

      MySQLSettings.Builder maxFileSize(Integer maxFileSize)

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

      Example: maxFileSize=512

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

      Example: maxFileSize=512

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parallelLoadThreads

      MySQLSettings.Builder parallelLoadThreads(Integer 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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • password

      MySQLSettings.Builder password(String password)

      Endpoint connection password.

      Parameters:
      password - Endpoint connection password.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • port

      MySQLSettings.Builder port(Integer port)

      Endpoint TCP port.

      Parameters:
      port - Endpoint TCP port.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverName

      MySQLSettings.Builder serverName(String serverName)

      The host name of the endpoint database.

      For an Amazon RDS MySQL instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.

      For an Aurora MySQL instance, this is the output of DescribeDBClusters, in the Endpoint field.

      Parameters:
      serverName - The host name of the endpoint database.

      For an Amazon RDS MySQL instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.

      For an Aurora MySQL instance, this is the output of DescribeDBClusters, in the Endpoint field.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverTimezone

      MySQLSettings.Builder serverTimezone(String serverTimezone)

      Specifies the time zone for the source MySQL database.

      Example: serverTimezone=US/Pacific;

      Note: Do not enclose time zones in single quotes.

      Parameters:
      serverTimezone - Specifies the time zone for the source MySQL database.

      Example: serverTimezone=US/Pacific;

      Note: Do not enclose time zones in single quotes.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • username

      MySQLSettings.Builder username(String username)

      Endpoint connection user name.

      Parameters:
      username - Endpoint connection user name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secretsManagerAccessRoleArn

      MySQLSettings.Builder secretsManagerAccessRoleArn(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secretsManagerSecretId

      MySQLSettings.Builder secretsManagerSecretId(String secretsManagerSecretId)

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

      Parameters:
      secretsManagerSecretId - The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executeTimeout

      MySQLSettings.Builder executeTimeout(Integer executeTimeout)

      Sets the client statement timeout (in seconds) for a MySQL source endpoint.

      Parameters:
      executeTimeout - Sets the client statement timeout (in seconds) for a MySQL source endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.