@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.
Constructor and Description |
---|
MySQLSettings() |
Modifier and Type | Method and Description |
---|---|
MySQLSettings |
clone() |
boolean |
equals(Object obj) |
String |
getAfterConnectScript()
Specifies a script to run immediately after AWS DMS connects to the endpoint.
|
Boolean |
getCleanSourceMetadataOnMismatch()
Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always
On availability group cluster.
|
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 |
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 AWS 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()
Fully qualified domain name of the endpoint.
|
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()
Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always
On availability group cluster.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAfterConnectScript(String afterConnectScript)
Specifies a script to run immediately after AWS DMS connects to the endpoint.
|
void |
setCleanSourceMetadataOnMismatch(Boolean cleanSourceMetadataOnMismatch)
Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always
On availability group cluster.
|
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 |
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 AWS 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)
Fully qualified domain name of the endpoint.
|
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 AWS DMS connects to the endpoint.
|
MySQLSettings |
withCleanSourceMetadataOnMismatch(Boolean cleanSourceMetadataOnMismatch)
Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always
On availability group cluster.
|
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 |
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 AWS 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)
Fully qualified domain name of the endpoint.
|
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.
|
public void setAfterConnectScript(String afterConnectScript)
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.
afterConnectScript
- 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.public 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.
public MySQLSettings withAfterConnectScript(String afterConnectScript)
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.
afterConnectScript
- 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.public void setCleanSourceMetadataOnMismatch(Boolean cleanSourceMetadataOnMismatch)
Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always
On availability group cluster. If you need DMS to poll all the nodes in the Always On cluster for transaction
backups, set this attribute to false
.
cleanSourceMetadataOnMismatch
- Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an
Always On availability group cluster. If you need DMS to poll all the nodes in the Always On cluster for
transaction backups, set this attribute to false
.public Boolean getCleanSourceMetadataOnMismatch()
Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always
On availability group cluster. If you need DMS to poll all the nodes in the Always On cluster for transaction
backups, set this attribute to false
.
false
.public MySQLSettings withCleanSourceMetadataOnMismatch(Boolean cleanSourceMetadataOnMismatch)
Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always
On availability group cluster. If you need DMS to poll all the nodes in the Always On cluster for transaction
backups, set this attribute to false
.
cleanSourceMetadataOnMismatch
- Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an
Always On availability group cluster. If you need DMS to poll all the nodes in the Always On cluster for
transaction backups, set this attribute to false
.public Boolean isCleanSourceMetadataOnMismatch()
Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always
On availability group cluster. If you need DMS to poll all the nodes in the Always On cluster for transaction
backups, set this attribute to false
.
false
.public void setDatabaseName(String databaseName)
Database name for the endpoint.
databaseName
- Database name for the endpoint.public String getDatabaseName()
Database name for the endpoint.
public MySQLSettings withDatabaseName(String databaseName)
Database name for the endpoint.
databaseName
- Database name for the endpoint.public void setEventsPollInterval(Integer eventsPollInterval)
Specifies how often to check the binary log for new changes/events when the database is idle.
Example: eventsPollInterval=5;
In the example, AWS DMS checks for changes in the binary logs every five seconds.
eventsPollInterval
- Specifies how often to check the binary log for new changes/events when the database is idle.
Example: eventsPollInterval=5;
In the example, AWS DMS checks for changes in the binary logs every five seconds.
public Integer getEventsPollInterval()
Specifies how often to check the binary log for new changes/events when the database is idle.
Example: eventsPollInterval=5;
In the example, AWS DMS checks for changes in the binary logs every five seconds.
Example: eventsPollInterval=5;
In the example, AWS DMS checks for changes in the binary logs every five seconds.
public MySQLSettings withEventsPollInterval(Integer eventsPollInterval)
Specifies how often to check the binary log for new changes/events when the database is idle.
Example: eventsPollInterval=5;
In the example, AWS DMS checks for changes in the binary logs every five seconds.
eventsPollInterval
- Specifies how often to check the binary log for new changes/events when the database is idle.
Example: eventsPollInterval=5;
In the example, AWS DMS checks for changes in the binary logs every five seconds.
public void setTargetDbType(String targetDbType)
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
Example: targetDbType=MULTIPLE_DATABASES
targetDbType
- Specifies where to migrate source tables on the target, either to a single database or multiple
databases.
Example: targetDbType=MULTIPLE_DATABASES
TargetDbType
public String getTargetDbType()
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
Example: targetDbType=MULTIPLE_DATABASES
Example: targetDbType=MULTIPLE_DATABASES
TargetDbType
public MySQLSettings withTargetDbType(String targetDbType)
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
Example: targetDbType=MULTIPLE_DATABASES
targetDbType
- Specifies where to migrate source tables on the target, either to a single database or multiple
databases.
Example: targetDbType=MULTIPLE_DATABASES
TargetDbType
public MySQLSettings withTargetDbType(TargetDbType targetDbType)
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
Example: targetDbType=MULTIPLE_DATABASES
targetDbType
- Specifies where to migrate source tables on the target, either to a single database or multiple
databases.
Example: targetDbType=MULTIPLE_DATABASES
TargetDbType
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
maxFileSize
- Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible
database.
Example: maxFileSize=512
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
Example: maxFileSize=512
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
maxFileSize
- Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible
database.
Example: maxFileSize=512
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.
Example: parallelLoadThreads=1
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.
Example: parallelLoadThreads=1
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.
Example: parallelLoadThreads=1
Example: parallelLoadThreads=1
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.
Example: parallelLoadThreads=1
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.
Example: parallelLoadThreads=1
public void setPassword(String password)
Endpoint connection password.
password
- Endpoint connection password.public String getPassword()
Endpoint connection password.
public MySQLSettings withPassword(String password)
Endpoint connection password.
password
- Endpoint connection password.public void setPort(Integer port)
Endpoint TCP port.
port
- Endpoint TCP port.public Integer getPort()
Endpoint TCP port.
public MySQLSettings withPort(Integer port)
Endpoint TCP port.
port
- Endpoint TCP port.public void setServerName(String serverName)
Fully qualified domain name of the endpoint.
serverName
- Fully qualified domain name of the endpoint.public String getServerName()
Fully qualified domain name of the endpoint.
public MySQLSettings withServerName(String serverName)
Fully qualified domain name of the endpoint.
serverName
- Fully qualified domain name of the endpoint.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.
serverTimezone
- Specifies the time zone for the source MySQL database.
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
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.
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
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.
serverTimezone
- Specifies the time zone for the source MySQL database.
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
public void setUsername(String username)
Endpoint connection user name.
username
- Endpoint connection user name.public String getUsername()
Endpoint connection user name.
public MySQLSettings withUsername(String username)
Endpoint connection user name.
username
- Endpoint connection user name.public void setSecretsManagerAccessRoleArn(String 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
. 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
and the SecretsManagerAccessRoleArn
and SecretsManagerSecretId
required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service
User Guide.
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
.
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
and the
SecretsManagerAccessRoleArn
and SecretsManagerSecretId
required to access it,
see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration
Service User Guide.
public 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
. 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
and the SecretsManagerAccessRoleArn
and SecretsManagerSecretId
required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service
User Guide.
SecretsManagerSecret
.
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
and the
SecretsManagerAccessRoleArn
and SecretsManagerSecretId
required to access it,
see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration
Service User Guide.
public MySQLSettings withSecretsManagerAccessRoleArn(String 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
. 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
and the SecretsManagerAccessRoleArn
and SecretsManagerSecretId
required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service
User Guide.
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
.
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
and the
SecretsManagerAccessRoleArn
and SecretsManagerSecretId
required to access it,
see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration
Service User Guide.
public void setSecretsManagerSecretId(String secretsManagerSecretId)
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the MySQL
endpoint connection details.
secretsManagerSecretId
- The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the
MySQL endpoint connection details.public String getSecretsManagerSecretId()
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the MySQL
endpoint connection details.
SecretsManagerSecret
that contains the
MySQL endpoint connection details.public MySQLSettings withSecretsManagerSecretId(String secretsManagerSecretId)
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the MySQL
endpoint connection details.
secretsManagerSecretId
- The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the
MySQL endpoint connection details.public String toString()
toString
in class Object
Object.toString()
public MySQLSettings clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.