MySQLSettings (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.databasemigrationservice.model.MySQLSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MySQLSettings
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides information that defines a MySQL endpoint.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MySQLSettings()

Constructors
Constructor and Description
`MySQLSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MySQLSettings`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAfterConnectScript()` Specifies a script to run immediately after DMS connects to the endpoint.
`Boolean`	`getCleanSourceMetadataOnMismatch()` Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
`String`	`getDatabaseName()` Database name for the endpoint.
`Integer`	`getEventsPollInterval()` Specifies how often to check the binary log for new changes/events when the database is idle.
`Integer`	`getExecuteTimeout()` Sets the client statement timeout (in seconds) for a MySQL source endpoint.
`Integer`	`getMaxFileSize()` Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
`Integer`	`getParallelLoadThreads()` Improves performance when loading data into the MySQL-compatible target database.
`String`	`getPassword()` Endpoint connection password.
`Integer`	`getPort()` Endpoint TCP port.
`String`	`getSecretsManagerAccessRoleArn()` 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`.
`String`	`getSecretsManagerSecretId()` The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details.
`String`	`getServerName()` The host name of the endpoint database.
`String`	`getServerTimezone()` Specifies the time zone for the source MySQL database.
`String`	`getTargetDbType()` Specifies where to migrate source tables on the target, either to a single database or multiple databases.
`String`	`getUsername()` Endpoint connection user name.
`int`	`hashCode()`
`Boolean`	`isCleanSourceMetadataOnMismatch()` Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAfterConnectScript(String afterConnectScript)` Specifies a script to run immediately after DMS connects to the endpoint.
`void`	`setCleanSourceMetadataOnMismatch(Boolean cleanSourceMetadataOnMismatch)` Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
`void`	`setDatabaseName(String databaseName)` Database name for the endpoint.
`void`	`setEventsPollInterval(Integer eventsPollInterval)` Specifies how often to check the binary log for new changes/events when the database is idle.
`void`	`setExecuteTimeout(Integer executeTimeout)` Sets the client statement timeout (in seconds) for a MySQL source endpoint.
`void`	`setMaxFileSize(Integer maxFileSize)` Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
`void`	`setParallelLoadThreads(Integer parallelLoadThreads)` Improves performance when loading data into the MySQL-compatible target database.
`void`	`setPassword(String password)` Endpoint connection password.
`void`	`setPort(Integer port)` Endpoint TCP port.
`void`	`setSecretsManagerAccessRoleArn(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`.
`void`	`setSecretsManagerSecretId(String secretsManagerSecretId)` The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details.
`void`	`setServerName(String serverName)` The host name of the endpoint database.
`void`	`setServerTimezone(String serverTimezone)` Specifies the time zone for the source MySQL database.
`void`	`setTargetDbType(String targetDbType)` Specifies where to migrate source tables on the target, either to a single database or multiple databases.
`void`	`setUsername(String username)` Endpoint connection user name.
`String`	`toString()` Returns a string representation of this object.
`MySQLSettings`	`withAfterConnectScript(String afterConnectScript)` Specifies a script to run immediately after DMS connects to the endpoint.
`MySQLSettings`	`withCleanSourceMetadataOnMismatch(Boolean cleanSourceMetadataOnMismatch)` Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
`MySQLSettings`	`withDatabaseName(String databaseName)` Database name for the endpoint.
`MySQLSettings`	`withEventsPollInterval(Integer eventsPollInterval)` Specifies how often to check the binary log for new changes/events when the database is idle.
`MySQLSettings`	`withExecuteTimeout(Integer executeTimeout)` Sets the client statement timeout (in seconds) for a MySQL source endpoint.
`MySQLSettings`	`withMaxFileSize(Integer maxFileSize)` Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
`MySQLSettings`	`withParallelLoadThreads(Integer parallelLoadThreads)` Improves performance when loading data into the MySQL-compatible target database.
`MySQLSettings`	`withPassword(String password)` Endpoint connection password.
`MySQLSettings`	`withPort(Integer port)` Endpoint TCP port.
`MySQLSettings`	`withSecretsManagerAccessRoleArn(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`.
`MySQLSettings`	`withSecretsManagerSecretId(String secretsManagerSecretId)` The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details.
`MySQLSettings`	`withServerName(String serverName)` The host name of the endpoint database.
`MySQLSettings`	`withServerTimezone(String serverTimezone)` Specifies the time zone for the source MySQL database.
`MySQLSettings`	`withTargetDbType(String targetDbType)` Specifies where to migrate source tables on the target, either to a single database or multiple databases.
`MySQLSettings`	`withTargetDbType(TargetDbType targetDbType)` Specifies where to migrate source tables on the target, either to a single database or multiple databases.
`MySQLSettings`	`withUsername(String username)` Endpoint connection user name.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MySQLSettings
```
public MySQLSettings()
```
- Method Detail
  - setAfterConnectScript
```
public void setAfterConnectScript(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.
  - getAfterConnectScript
```
public String getAfterConnectScript()
```
    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.
  - withAfterConnectScript
```
public MySQLSettings withAfterConnectScript(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.
  - setCleanSourceMetadataOnMismatch
```
public void setCleanSourceMetadataOnMismatch(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.
  - getCleanSourceMetadataOnMismatch
```
public Boolean 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.
    
    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.
  - withCleanSourceMetadataOnMismatch
```
public MySQLSettings withCleanSourceMetadataOnMismatch(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.
  - isCleanSourceMetadataOnMismatch
```
public Boolean isCleanSourceMetadataOnMismatch()
```
    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.
  - setDatabaseName
```
public void setDatabaseName(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.
  - getDatabaseName
```
public String getDatabaseName()
```
    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.
  - withDatabaseName
```
public MySQLSettings withDatabaseName(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.
  - setEventsPollInterval
```
public void setEventsPollInterval(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.
  - getEventsPollInterval
```
public Integer 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, 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.
  - withEventsPollInterval
```
public MySQLSettings withEventsPollInterval(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.
  - setTargetDbType
```
public void setTargetDbType(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
    
    See Also:
    
    TargetDbType
  - getTargetDbType
```
public 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
    
    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
  - withTargetDbType
```
public MySQLSettings withTargetDbType(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
  - withTargetDbType
```
public MySQLSettings withTargetDbType(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:
    
    TargetDbType
  - setMaxFileSize
```
public void setMaxFileSize(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
  - getMaxFileSize
```
public Integer getMaxFileSize()
```
    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
  - withMaxFileSize
```
public MySQLSettings withMaxFileSize(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.
  - setParallelLoadThreads
```
public void setParallelLoadThreads(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
  - getParallelLoadThreads
```
public Integer 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
    
    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
  - withParallelLoadThreads
```
public MySQLSettings withParallelLoadThreads(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.
  - setPassword
```
public void setPassword(String password)
```
    Endpoint connection password.
    
    Parameters:
    
    password - Endpoint connection password.
  - getPassword
```
public String getPassword()
```
    Endpoint connection password.
    
    Returns:
    
    Endpoint connection password.
  - withPassword
```
public MySQLSettings withPassword(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.
  - setPort
```
public void setPort(Integer port)
```
    Endpoint TCP port.
    
    Parameters:
    
    port - Endpoint TCP port.
  - getPort
```
public Integer getPort()
```
    Endpoint TCP port.
    
    Returns:
    
    Endpoint TCP port.
  - withPort
```
public MySQLSettings withPort(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.
  - setServerName
```
public void setServerName(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.
  - getServerName
```
public String getServerName()
```
    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.
  - withServerName
```
public MySQLSettings withServerName(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.
  - setServerTimezone
```
public void setServerTimezone(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.
  - getServerTimezone
```
public String getServerTimezone()
```
    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.
  - withServerTimezone
```
public MySQLSettings withServerTimezone(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.
  - setUsername
```
public void setUsername(String username)
```
    Endpoint connection user name.
    
    Parameters:
    
    username - Endpoint connection user name.
  - getUsername
```
public String getUsername()
```
    Endpoint connection user name.
    
    Returns:
    
    Endpoint connection user name.
  - withUsername
```
public MySQLSettings withUsername(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.
  - setSecretsManagerAccessRoleArn
```
public void setSecretsManagerAccessRoleArn(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.
  - getSecretsManagerAccessRoleArn
```
public String getSecretsManagerAccessRoleArn()
```
    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.
  - withSecretsManagerAccessRoleArn
```
public MySQLSettings withSecretsManagerAccessRoleArn(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.
  - setSecretsManagerSecretId
```
public void setSecretsManagerSecretId(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.
  - getSecretsManagerSecretId
```
public String getSecretsManagerSecretId()
```
    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.
  - withSecretsManagerSecretId
```
public MySQLSettings withSecretsManagerSecretId(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.
  - setExecuteTimeout
```
public void setExecuteTimeout(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.
  - getExecuteTimeout
```
public Integer getExecuteTimeout()
```
    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.
  - withExecuteTimeout
```
public MySQLSettings withExecuteTimeout(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public MySQLSettings clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.771

Class MySQLSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MySQLSettings

Method Detail

setAfterConnectScript

getAfterConnectScript

withAfterConnectScript

setCleanSourceMetadataOnMismatch

getCleanSourceMetadataOnMismatch

withCleanSourceMetadataOnMismatch

isCleanSourceMetadataOnMismatch

setDatabaseName

getDatabaseName

withDatabaseName

setEventsPollInterval

getEventsPollInterval

withEventsPollInterval

setTargetDbType

getTargetDbType

withTargetDbType

withTargetDbType

setMaxFileSize

getMaxFileSize

withMaxFileSize

setParallelLoadThreads

getParallelLoadThreads

withParallelLoadThreads

setPassword

getPassword

withPassword

setPort

getPort

withPort

setServerName

getServerName

withServerName

setServerTimezone

getServerTimezone

withServerTimezone

setUsername

getUsername

withUsername

setSecretsManagerAccessRoleArn

getSecretsManagerAccessRoleArn

withSecretsManagerAccessRoleArn

setSecretsManagerSecretId

getSecretsManagerSecretId

withSecretsManagerSecretId

setExecuteTimeout

getExecuteTimeout

withExecuteTimeout

toString

equals

hashCode

clone

marshall