Class: Aws::DatabaseMigrationService::Types::MySQLSettings
- Inherits:
-
Struct
- Object
- Struct
- Aws::DatabaseMigrationService::Types::MySQLSettings
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-databasemigrationservice/types.rb
Overview
Provides information that defines a MySQL endpoint.
Constant Summary collapse
- SENSITIVE =
[:password]
Instance Attribute Summary collapse
-
#after_connect_script ⇒ String
Specifies a script to run immediately after DMS connects to the endpoint.
-
#clean_source_metadata_on_mismatch ⇒ Boolean
Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
-
#database_name ⇒ String
Database name for the endpoint.
-
#events_poll_interval ⇒ Integer
Specifies how often to check the binary log for new changes/events when the database is idle.
-
#execute_timeout ⇒ Integer
Sets the client statement timeout (in seconds) for a MySQL source endpoint.
-
#max_file_size ⇒ Integer
Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
-
#parallel_load_threads ⇒ Integer
Improves performance when loading data into the MySQL-compatible target database.
-
#password ⇒ String
Endpoint connection password.
-
#port ⇒ Integer
Endpoint TCP port.
-
#secrets_manager_access_role_arn ⇒ 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`.
-
#secrets_manager_secret_id ⇒ String
The full ARN, partial ARN, or friendly name of the ‘SecretsManagerSecret` that contains the MySQL endpoint connection details.
-
#server_name ⇒ String
The host name of the endpoint database.
-
#server_timezone ⇒ String
Specifies the time zone for the source MySQL database.
-
#target_db_type ⇒ String
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
-
#username ⇒ String
Endpoint connection user name.
Instance Attribute Details
#after_connect_script ⇒ 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.
8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 |
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8697 class MySQLSettings < Struct.new( :after_connect_script, :clean_source_metadata_on_mismatch, :database_name, :events_poll_interval, :target_db_type, :max_file_size, :parallel_load_threads, :password, :port, :server_name, :server_timezone, :username, :secrets_manager_access_role_arn, :secrets_manager_secret_id, :execute_timeout) SENSITIVE = [:password] include Aws::Structure end |
#clean_source_metadata_on_mismatch ⇒ Boolean
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.
8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 |
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8697 class MySQLSettings < Struct.new( :after_connect_script, :clean_source_metadata_on_mismatch, :database_name, :events_poll_interval, :target_db_type, :max_file_size, :parallel_load_threads, :password, :port, :server_name, :server_timezone, :username, :secrets_manager_access_role_arn, :secrets_manager_secret_id, :execute_timeout) SENSITIVE = [:password] include Aws::Structure end |
#database_name ⇒ 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.
8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 |
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8697 class MySQLSettings < Struct.new( :after_connect_script, :clean_source_metadata_on_mismatch, :database_name, :events_poll_interval, :target_db_type, :max_file_size, :parallel_load_threads, :password, :port, :server_name, :server_timezone, :username, :secrets_manager_access_role_arn, :secrets_manager_secret_id, :execute_timeout) SENSITIVE = [:password] include Aws::Structure end |
#events_poll_interval ⇒ Integer
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.
8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 |
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8697 class MySQLSettings < Struct.new( :after_connect_script, :clean_source_metadata_on_mismatch, :database_name, :events_poll_interval, :target_db_type, :max_file_size, :parallel_load_threads, :password, :port, :server_name, :server_timezone, :username, :secrets_manager_access_role_arn, :secrets_manager_secret_id, :execute_timeout) SENSITIVE = [:password] include Aws::Structure end |
#execute_timeout ⇒ Integer
Sets the client statement timeout (in seconds) for a MySQL source endpoint.
8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 |
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8697 class MySQLSettings < Struct.new( :after_connect_script, :clean_source_metadata_on_mismatch, :database_name, :events_poll_interval, :target_db_type, :max_file_size, :parallel_load_threads, :password, :port, :server_name, :server_timezone, :username, :secrets_manager_access_role_arn, :secrets_manager_secret_id, :execute_timeout) SENSITIVE = [:password] include Aws::Structure end |
#max_file_size ⇒ Integer
Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
Example: ‘maxFileSize=512`
8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 |
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8697 class MySQLSettings < Struct.new( :after_connect_script, :clean_source_metadata_on_mismatch, :database_name, :events_poll_interval, :target_db_type, :max_file_size, :parallel_load_threads, :password, :port, :server_name, :server_timezone, :username, :secrets_manager_access_role_arn, :secrets_manager_secret_id, :execute_timeout) SENSITIVE = [:password] include Aws::Structure end |
#parallel_load_threads ⇒ Integer
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`
8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 |
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8697 class MySQLSettings < Struct.new( :after_connect_script, :clean_source_metadata_on_mismatch, :database_name, :events_poll_interval, :target_db_type, :max_file_size, :parallel_load_threads, :password, :port, :server_name, :server_timezone, :username, :secrets_manager_access_role_arn, :secrets_manager_secret_id, :execute_timeout) SENSITIVE = [:password] include Aws::Structure end |
#password ⇒ String
Endpoint connection password.
8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 |
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8697 class MySQLSettings < Struct.new( :after_connect_script, :clean_source_metadata_on_mismatch, :database_name, :events_poll_interval, :target_db_type, :max_file_size, :parallel_load_threads, :password, :port, :server_name, :server_timezone, :username, :secrets_manager_access_role_arn, :secrets_manager_secret_id, :execute_timeout) SENSITIVE = [:password] include Aws::Structure end |
#port ⇒ Integer
Endpoint TCP port.
8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 |
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8697 class MySQLSettings < Struct.new( :after_connect_script, :clean_source_metadata_on_mismatch, :database_name, :events_poll_interval, :target_db_type, :max_file_size, :parallel_load_threads, :password, :port, :server_name, :server_timezone, :username, :secrets_manager_access_role_arn, :secrets_manager_secret_id, :execute_timeout) SENSITIVE = [:password] include Aws::Structure end |
#secrets_manager_access_role_arn ⇒ 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.
<note markdown=“1”> 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*.
</note>
[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 |
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8697 class MySQLSettings < Struct.new( :after_connect_script, :clean_source_metadata_on_mismatch, :database_name, :events_poll_interval, :target_db_type, :max_file_size, :parallel_load_threads, :password, :port, :server_name, :server_timezone, :username, :secrets_manager_access_role_arn, :secrets_manager_secret_id, :execute_timeout) SENSITIVE = [:password] include Aws::Structure end |
#secrets_manager_secret_id ⇒ String
The full ARN, partial ARN, or friendly name of the ‘SecretsManagerSecret` that contains the MySQL endpoint connection details.
8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 |
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8697 class MySQLSettings < Struct.new( :after_connect_script, :clean_source_metadata_on_mismatch, :database_name, :events_poll_interval, :target_db_type, :max_file_size, :parallel_load_threads, :password, :port, :server_name, :server_timezone, :username, :secrets_manager_access_role_arn, :secrets_manager_secret_id, :execute_timeout) SENSITIVE = [:password] include Aws::Structure end |
#server_name ⇒ 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.
[1]: docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html [2]: docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html
8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 |
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8697 class MySQLSettings < Struct.new( :after_connect_script, :clean_source_metadata_on_mismatch, :database_name, :events_poll_interval, :target_db_type, :max_file_size, :parallel_load_threads, :password, :port, :server_name, :server_timezone, :username, :secrets_manager_access_role_arn, :secrets_manager_secret_id, :execute_timeout) SENSITIVE = [:password] include Aws::Structure end |
#server_timezone ⇒ String
Specifies the time zone for the source MySQL database.
Example: ‘serverTimezone=US/Pacific;`
Note: Do not enclose time zones in single quotes.
8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 |
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8697 class MySQLSettings < Struct.new( :after_connect_script, :clean_source_metadata_on_mismatch, :database_name, :events_poll_interval, :target_db_type, :max_file_size, :parallel_load_threads, :password, :port, :server_name, :server_timezone, :username, :secrets_manager_access_role_arn, :secrets_manager_secret_id, :execute_timeout) SENSITIVE = [:password] include Aws::Structure end |
#target_db_type ⇒ String
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`
8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 |
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8697 class MySQLSettings < Struct.new( :after_connect_script, :clean_source_metadata_on_mismatch, :database_name, :events_poll_interval, :target_db_type, :max_file_size, :parallel_load_threads, :password, :port, :server_name, :server_timezone, :username, :secrets_manager_access_role_arn, :secrets_manager_secret_id, :execute_timeout) SENSITIVE = [:password] include Aws::Structure end |
#username ⇒ String
Endpoint connection user name.
8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 |
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8697 class MySQLSettings < Struct.new( :after_connect_script, :clean_source_metadata_on_mismatch, :database_name, :events_poll_interval, :target_db_type, :max_file_size, :parallel_load_threads, :password, :port, :server_name, :server_timezone, :username, :secrets_manager_access_role_arn, :secrets_manager_secret_id, :execute_timeout) SENSITIVE = [:password] include Aws::Structure end |