Class GcpMySQLSettings
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<GcpMySQLSettings.Builder,
GcpMySQLSettings>
Settings in JSON format for the source GCP MySQL endpoint.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
Specifies a script to run immediately after DMS connects to the endpoint.static GcpMySQLSettings.Builder
builder()
final Boolean
Cleans and recreates table metadata information on the replication instance when a mismatch occurs.final String
Database name for the endpoint.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
Specifies how often to check the binary log for new changes/events when the database is idle.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.final Integer
Improves performance when loading data into the MySQL-compatible target database.final String
password()
Endpoint connection password.final Integer
port()
Endpoint TCP port.final String
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 inSecretsManagerSecret.
The role must allow theiam:PassRole
action.final String
The full ARN, partial ARN, or friendly name of theSecretsManagerSecret
that contains the MySQL endpoint connection details.static Class
<? extends GcpMySQLSettings.Builder> final String
The MySQL host name.final String
Specifies the time zone for the source MySQL database.final TargetDbType
Specifies where to migrate source tables on the target, either to a single database or multiple databases.final String
Specifies where to migrate source tables on the target, either to a single database or multiple databases.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
username()
Endpoint connection user name.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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 theCreateEndpoint
orModifyEndpoint
API call. SpecifyingDatabaseName
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 theCreateEndpoint
orModifyEndpoint
API call. SpecifyingDatabaseName
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
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
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
Example:
targetDbType=MULTIPLE_DATABASES
If the service returns an enum value that is not available in the current SDK version,
targetDbType
will returnTargetDbType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetDbTypeAsString()
.- Returns:
- Specifies where to migrate source tables on the target, either to a single database or multiple
databases.
Example:
targetDbType=MULTIPLE_DATABASES
- See Also:
-
targetDbTypeAsString
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
Example:
targetDbType=MULTIPLE_DATABASES
If the service returns an enum value that is not available in the current SDK version,
targetDbType
will returnTargetDbType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetDbTypeAsString()
.- Returns:
- Specifies where to migrate source tables on the target, either to a single database or multiple
databases.
Example:
targetDbType=MULTIPLE_DATABASES
- See Also:
-
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
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
Endpoint connection password.
- Returns:
- Endpoint connection password.
-
port
Endpoint TCP port.
- Returns:
- Endpoint TCP port.
-
serverName
The MySQL host name.
- Returns:
- The MySQL host name.
-
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
Endpoint connection user name.
- Returns:
- Endpoint connection user name.
-
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 theiam: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 forUserName
,Password
,ServerName
, andPort
. You can't specify both. For more information on creating thisSecretsManagerSecret
and theSecretsManagerAccessRoleArn
andSecretsManagerSecretId
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 theiam: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 forUserName
,Password
,ServerName
, andPort
. You can't specify both. For more information on creating thisSecretsManagerSecret
and theSecretsManagerAccessRoleArn
andSecretsManagerSecretId
required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
-
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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GcpMySQLSettings.Builder,
GcpMySQLSettings> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-