#[non_exhaustive]pub struct GcpMySqlSettingsBuilder { /* private fields */ }
Expand description
A builder for GcpMySqlSettings
.
Implementations§
source§impl GcpMySqlSettingsBuilder
impl GcpMySqlSettingsBuilder
sourcepub fn after_connect_script(self, input: impl Into<String>) -> Self
pub fn after_connect_script(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_after_connect_script(self, input: Option<String>) -> Self
pub fn set_after_connect_script(self, input: Option<String>) -> Self
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.
sourcepub fn get_after_connect_script(&self) -> &Option<String>
pub fn get_after_connect_script(&self) -> &Option<String>
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.
sourcepub fn clean_source_metadata_on_mismatch(self, input: bool) -> Self
pub fn clean_source_metadata_on_mismatch(self, input: bool) -> Self
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.
sourcepub fn set_clean_source_metadata_on_mismatch(self, input: Option<bool>) -> Self
pub fn set_clean_source_metadata_on_mismatch(self, input: Option<bool>) -> Self
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.
sourcepub fn get_clean_source_metadata_on_mismatch(&self) -> &Option<bool>
pub fn get_clean_source_metadata_on_mismatch(&self) -> &Option<bool>
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.
sourcepub fn database_name(self, input: impl Into<String>) -> Self
pub fn database_name(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_database_name(self, input: Option<String>) -> Self
pub fn set_database_name(self, input: Option<String>) -> Self
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.
sourcepub fn get_database_name(&self) -> &Option<String>
pub fn get_database_name(&self) -> &Option<String>
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.
sourcepub fn events_poll_interval(self, input: i32) -> Self
pub fn events_poll_interval(self, input: i32) -> Self
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.
sourcepub fn set_events_poll_interval(self, input: Option<i32>) -> Self
pub fn set_events_poll_interval(self, input: Option<i32>) -> Self
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.
sourcepub fn get_events_poll_interval(&self) -> &Option<i32>
pub fn get_events_poll_interval(&self) -> &Option<i32>
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.
sourcepub fn target_db_type(self, input: TargetDbType) -> Self
pub fn target_db_type(self, input: TargetDbType) -> Self
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
Example: targetDbType=MULTIPLE_DATABASES
sourcepub fn set_target_db_type(self, input: Option<TargetDbType>) -> Self
pub fn set_target_db_type(self, input: Option<TargetDbType>) -> Self
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
Example: targetDbType=MULTIPLE_DATABASES
sourcepub fn get_target_db_type(&self) -> &Option<TargetDbType>
pub fn get_target_db_type(&self) -> &Option<TargetDbType>
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
Example: targetDbType=MULTIPLE_DATABASES
sourcepub fn max_file_size(self, input: i32) -> Self
pub fn max_file_size(self, input: i32) -> Self
Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
Example: maxFileSize=512
sourcepub fn set_max_file_size(self, input: Option<i32>) -> Self
pub fn set_max_file_size(self, input: Option<i32>) -> Self
Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
Example: maxFileSize=512
sourcepub fn get_max_file_size(&self) -> &Option<i32>
pub fn get_max_file_size(&self) -> &Option<i32>
Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
Example: maxFileSize=512
sourcepub fn parallel_load_threads(self, input: i32) -> Self
pub fn parallel_load_threads(self, input: i32) -> Self
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
sourcepub fn set_parallel_load_threads(self, input: Option<i32>) -> Self
pub fn set_parallel_load_threads(self, input: Option<i32>) -> Self
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
sourcepub fn get_parallel_load_threads(&self) -> &Option<i32>
pub fn get_parallel_load_threads(&self) -> &Option<i32>
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
sourcepub fn set_password(self, input: Option<String>) -> Self
pub fn set_password(self, input: Option<String>) -> Self
Endpoint connection password.
sourcepub fn get_password(&self) -> &Option<String>
pub fn get_password(&self) -> &Option<String>
Endpoint connection password.
sourcepub fn server_name(self, input: impl Into<String>) -> Self
pub fn server_name(self, input: impl Into<String>) -> Self
The MySQL host name.
sourcepub fn set_server_name(self, input: Option<String>) -> Self
pub fn set_server_name(self, input: Option<String>) -> Self
The MySQL host name.
sourcepub fn get_server_name(&self) -> &Option<String>
pub fn get_server_name(&self) -> &Option<String>
The MySQL host name.
sourcepub fn server_timezone(self, input: impl Into<String>) -> Self
pub fn server_timezone(self, input: impl Into<String>) -> Self
Specifies the time zone for the source MySQL database.
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
sourcepub fn set_server_timezone(self, input: Option<String>) -> Self
pub fn set_server_timezone(self, input: Option<String>) -> Self
Specifies the time zone for the source MySQL database.
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
sourcepub fn get_server_timezone(&self) -> &Option<String>
pub fn get_server_timezone(&self) -> &Option<String>
Specifies the time zone for the source MySQL database.
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
sourcepub fn set_username(self, input: Option<String>) -> Self
pub fn set_username(self, input: Option<String>) -> Self
Endpoint connection user name.
sourcepub fn get_username(&self) -> &Option<String>
pub fn get_username(&self) -> &Option<String>
Endpoint connection user name.
sourcepub fn secrets_manager_access_role_arn(self, input: impl Into<String>) -> Self
pub fn secrets_manager_access_role_arn(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_secrets_manager_access_role_arn(self, input: Option<String>) -> Self
pub fn set_secrets_manager_access_role_arn(self, input: Option<String>) -> Self
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.
sourcepub fn get_secrets_manager_access_role_arn(&self) -> &Option<String>
pub fn get_secrets_manager_access_role_arn(&self) -> &Option<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 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.
sourcepub fn secrets_manager_secret_id(self, input: impl Into<String>) -> Self
pub fn secrets_manager_secret_id(self, input: impl Into<String>) -> Self
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the MySQL endpoint connection details.
sourcepub fn set_secrets_manager_secret_id(self, input: Option<String>) -> Self
pub fn set_secrets_manager_secret_id(self, input: Option<String>) -> Self
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the MySQL endpoint connection details.
sourcepub fn get_secrets_manager_secret_id(&self) -> &Option<String>
pub fn get_secrets_manager_secret_id(&self) -> &Option<String>
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the MySQL endpoint connection details.
sourcepub fn build(self) -> GcpMySqlSettings
pub fn build(self) -> GcpMySqlSettings
Consumes the builder and constructs a GcpMySqlSettings
.
Trait Implementations§
source§impl Clone for GcpMySqlSettingsBuilder
impl Clone for GcpMySqlSettingsBuilder
source§fn clone(&self) -> GcpMySqlSettingsBuilder
fn clone(&self) -> GcpMySqlSettingsBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for GcpMySqlSettingsBuilder
impl Debug for GcpMySqlSettingsBuilder
source§impl Default for GcpMySqlSettingsBuilder
impl Default for GcpMySqlSettingsBuilder
source§fn default() -> GcpMySqlSettingsBuilder
fn default() -> GcpMySqlSettingsBuilder
source§impl PartialEq for GcpMySqlSettingsBuilder
impl PartialEq for GcpMySqlSettingsBuilder
source§fn eq(&self, other: &GcpMySqlSettingsBuilder) -> bool
fn eq(&self, other: &GcpMySqlSettingsBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.