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

Class MySQLSettings

    • Method Detail

      • afterConnectScript

        public final 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.

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

      • cleanSourceMetadataOnMismatch

        public final 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.

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

      • databaseName

        public final 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.

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

      • eventsPollInterval

        public final 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.

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

      • targetDbType

        public final 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

        If the service returns an enum value that is not available in the current SDK version, targetDbType will return TargetDbType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetDbTypeAsString().

        Returns:
        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:
        TargetDbType

      • targetDbTypeAsString

        public final String targetDbTypeAsString()

        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

        If the service returns an enum value that is not available in the current SDK version, targetDbType will return TargetDbType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetDbTypeAsString().

        Returns:
        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:
        TargetDbType

      • maxFileSize

        public final Integer maxFileSize()

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

        Example: maxFileSize=512

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

        Example: maxFileSize=512

      • parallelLoadThreads

        public final 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

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

      • password

        public final String password()

        Endpoint connection password.

        Returns:
        Endpoint connection password.

      • port

        public final Integer port()

        Endpoint TCP port.

        Returns:
        Endpoint TCP port.

      • serverName

        public final 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.

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

      • serverTimezone

        public final String serverTimezone()

        Specifies the time zone for the source MySQL database.

        Example: serverTimezone=US/Pacific;

        Note: Do not enclose time zones in single quotes.

        Returns:
        Specifies the time zone for the source MySQL database.

        Example: serverTimezone=US/Pacific;

        Note: Do not enclose time zones in single quotes.

      • username

        public final String username()

        Endpoint connection user name.

        Returns:
        Endpoint connection user name.

      • secretsManagerAccessRoleArn

        public final 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.

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

      • secretsManagerSecretId

        public final String secretsManagerSecretId()

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

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

      • executeTimeout

        public final Integer executeTimeout()

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

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

      • serviceAccessRoleArn

        public final String serviceAccessRoleArn()

        The IAM role you can use to authenticate when connecting to your endpoint. Ensure to include iam:PassRole and rds-db:connect actions in permission policy.

        Returns:
        The IAM role you can use to authenticate when connecting to your endpoint. Ensure to include iam:PassRole and rds-db:connect actions in permission policy.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)