Struct MySqlSettings

#[non_exhaustive]
pub struct MySqlSettings {

    pub after_connect_script: Option<String>,
    pub clean_source_metadata_on_mismatch: Option<bool>,
    pub database_name: Option<String>,
    pub events_poll_interval: Option<i32>,
    pub target_db_type: Option<TargetDbType>,
    pub max_file_size: Option<i32>,
    pub parallel_load_threads: Option<i32>,
    pub password: Option<String>,
    pub port: Option<i32>,
    pub server_name: Option<String>,
    pub server_timezone: Option<String>,
    pub username: Option<String>,
    pub secrets_manager_access_role_arn: Option<String>,
    pub secrets_manager_secret_id: Option<String>,
    pub execute_timeout: Option<i32>,
}

Provides information that defines a MySQL endpoint.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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

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

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

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

target_db_type: Option<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

max_file_size: Option<i32>

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

Example: maxFileSize=512

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

password: Option<String>

Endpoint connection password.

port: Option<i32>

Endpoint TCP port.

server_name: Option<String>

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.

server_timezone: Option<String>

Specifies the time zone for the source MySQL database.

Example: serverTimezone=US/Pacific;

Note: Do not enclose time zones in single quotes.

username: Option<String>

Endpoint connection user name.

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

secrets_manager_secret_id: Option<String>

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

execute_timeout: Option<i32>

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

Implementations

impl MySqlSettings

pub fn after_connect_script(&self) -> Option<&str>

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.

pub fn 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.

pub fn database_name(&self) -> Option<&str>

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.

pub fn 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.

pub fn target_db_type(&self) -> Option<&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

pub fn 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

pub fn 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

pub fn password(&self) -> Option<&str>

Endpoint connection password.

pub fn port(&self) -> Option<i32>

Endpoint TCP port.

pub fn server_name(&self) -> Option<&str>

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.

pub fn server_timezone(&self) -> Option<&str>

Specifies the time zone for the source MySQL database.

Example: serverTimezone=US/Pacific;

Note: Do not enclose time zones in single quotes.

pub fn username(&self) -> Option<&str>

Endpoint connection user name.

pub fn secrets_manager_access_role_arn(&self) -> Option<&str>

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.

pub fn secrets_manager_secret_id(&self) -> Option<&str>

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

pub fn execute_timeout(&self) -> Option<i32>

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

impl MySqlSettings

pub fn builder() -> MySqlSettingsBuilder

Creates a new builder-style object to manufacture MySqlSettings.

Trait Implementations

impl Clone for MySqlSettings

fn clone(&self) -> MySqlSettings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MySqlSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for MySqlSettings

fn eq(&self, other: &MySqlSettings) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MySqlSettings