Class: Aws::DatabaseMigrationService::Types::MySQLSettings

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb

Overview

Note:

When making an API call, you may pass MySQLSettings data as a hash:

{
  after_connect_script: "String",
  clean_source_metadata_on_mismatch: false,
  database_name: "String",
  events_poll_interval: 1,
  target_db_type: "specific-database", # accepts specific-database, multiple-databases
  max_file_size: 1,
  parallel_load_threads: 1,
  password: "SecretString",
  port: 1,
  server_name: "String",
  server_timezone: "String",
  username: "String",
  secrets_manager_access_role_arn: "String",
  secrets_manager_secret_id: "String",
}

Provides information that defines a MySQL endpoint.

Constant Summary collapse

SENSITIVE =
[:password]

Instance Attribute Summary collapse

Instance Attribute Details

#after_connect_scriptString

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:

  • (String)


6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6211

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#clean_source_metadata_on_mismatchBoolean

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.

Returns:

  • (Boolean)


6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6211

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#database_nameString

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.

Returns:

  • (String)


6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6211

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#events_poll_intervalInteger

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:

  • (Integer)


6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6211

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#max_file_sizeInteger

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

Example: maxFileSize=512

Returns:

  • (Integer)


6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6211

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#parallel_load_threadsInteger

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:

  • (Integer)


6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6211

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#passwordString

Endpoint connection password.

Returns:

  • (String)


6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6211

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#portInteger

Endpoint TCP port.

Returns:

  • (Integer)


6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6211

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#secrets_manager_access_role_arnString

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.

Returns:

  • (String)


6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6211

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#secrets_manager_secret_idString

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

Returns:

  • (String)


6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6211

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#server_nameString

Fully qualified domain name of the endpoint.

Returns:

  • (String)


6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6211

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#server_timezoneString

Specifies the time zone for the source MySQL database.

Example: serverTimezone=US/Pacific;

Note: Do not enclose time zones in single quotes.

Returns:

  • (String)


6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6211

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#target_db_typeString

Specifies where to migrate source tables on the target, either to a single database or multiple databases.

Example: targetDbType=MULTIPLE_DATABASES

Returns:

  • (String)


6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6211

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)
  SENSITIVE = [:password]
  include Aws::Structure
end

#usernameString

Endpoint connection user name.

Returns:

  • (String)


6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6211

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)
  SENSITIVE = [:password]
  include Aws::Structure
end