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",
  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",
}

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 AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.

Returns:

  • (String)


5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5436

class MySQLSettings < Struct.new(
  :after_connect_script,
  :database_name,
  :events_poll_interval,
  :target_db_type,
  :max_file_size,
  :parallel_load_threads,
  :password,
  :port,
  :server_name,
  :server_timezone,
  :username)
  SENSITIVE = [:password]
  include Aws::Structure
end

#database_nameString

Database name for the endpoint.

Returns:

  • (String)


5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5436

class MySQLSettings < Struct.new(
  :after_connect_script,
  :database_name,
  :events_poll_interval,
  :target_db_type,
  :max_file_size,
  :parallel_load_threads,
  :password,
  :port,
  :server_name,
  :server_timezone,
  :username)
  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.

Example: eventsPollInterval=5;

In the example, AWS DMS checks for changes in the binary logs every five seconds.

Returns:

  • (Integer)


5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5436

class MySQLSettings < Struct.new(
  :after_connect_script,
  :database_name,
  :events_poll_interval,
  :target_db_type,
  :max_file_size,
  :parallel_load_threads,
  :password,
  :port,
  :server_name,
  :server_timezone,
  :username)
  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)


5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5436

class MySQLSettings < Struct.new(
  :after_connect_script,
  :database_name,
  :events_poll_interval,
  :target_db_type,
  :max_file_size,
  :parallel_load_threads,
  :password,
  :port,
  :server_name,
  :server_timezone,
  :username)
  SENSITIVE = [:password]
  include Aws::Structure
end

#parallel_load_threadsInteger

Improves performance when loading data into the MySQLcompatible 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.

Example: parallelLoadThreads=1

Returns:

  • (Integer)


5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5436

class MySQLSettings < Struct.new(
  :after_connect_script,
  :database_name,
  :events_poll_interval,
  :target_db_type,
  :max_file_size,
  :parallel_load_threads,
  :password,
  :port,
  :server_name,
  :server_timezone,
  :username)
  SENSITIVE = [:password]
  include Aws::Structure
end

#passwordString

Endpoint connection password.

Returns:

  • (String)


5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5436

class MySQLSettings < Struct.new(
  :after_connect_script,
  :database_name,
  :events_poll_interval,
  :target_db_type,
  :max_file_size,
  :parallel_load_threads,
  :password,
  :port,
  :server_name,
  :server_timezone,
  :username)
  SENSITIVE = [:password]
  include Aws::Structure
end

#portInteger

Endpoint TCP port.

Returns:

  • (Integer)


5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5436

class MySQLSettings < Struct.new(
  :after_connect_script,
  :database_name,
  :events_poll_interval,
  :target_db_type,
  :max_file_size,
  :parallel_load_threads,
  :password,
  :port,
  :server_name,
  :server_timezone,
  :username)
  SENSITIVE = [:password]
  include Aws::Structure
end

#server_nameString

Fully qualified domain name of the endpoint.

Returns:

  • (String)


5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5436

class MySQLSettings < Struct.new(
  :after_connect_script,
  :database_name,
  :events_poll_interval,
  :target_db_type,
  :max_file_size,
  :parallel_load_threads,
  :password,
  :port,
  :server_name,
  :server_timezone,
  :username)
  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)


5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5436

class MySQLSettings < Struct.new(
  :after_connect_script,
  :database_name,
  :events_poll_interval,
  :target_db_type,
  :max_file_size,
  :parallel_load_threads,
  :password,
  :port,
  :server_name,
  :server_timezone,
  :username)
  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)


5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5436

class MySQLSettings < Struct.new(
  :after_connect_script,
  :database_name,
  :events_poll_interval,
  :target_db_type,
  :max_file_size,
  :parallel_load_threads,
  :password,
  :port,
  :server_name,
  :server_timezone,
  :username)
  SENSITIVE = [:password]
  include Aws::Structure
end

#usernameString

Endpoint connection user name.

Returns:

  • (String)


5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5436

class MySQLSettings < Struct.new(
  :after_connect_script,
  :database_name,
  :events_poll_interval,
  :target_db_type,
  :max_file_size,
  :parallel_load_threads,
  :password,
  :port,
  :server_name,
  :server_timezone,
  :username)
  SENSITIVE = [:password]
  include Aws::Structure
end