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

Inherits:

Struct

Object
Struct
Aws::DatabaseMigrationService::Types::MySQLSettings

show all

Defined in:: gems/aws-sdk-databasemigrationservice/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.
#authentication_method ⇒ String
This attribute allows you to specify the authentication method as "iam auth".
#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.
#service_access_role_arn ⇒ String
The IAM role you can use to authenticate when connecting to your endpoint.
#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.

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9341

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

#authentication_method ⇒ `String`

This attribute allows you to specify the authentication method as "iam auth".

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9341

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,
  :service_access_role_arn,
  :authentication_method)
  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.

Returns:

(Boolean)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9341

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,
  :service_access_role_arn,
  :authentication_method)
  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.

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9341

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,
  :service_access_role_arn,
  :authentication_method)
  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.

Returns:

(Integer)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9341

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

#execute_timeout ⇒ `Integer`

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

Returns:

(Integer)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9341

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,
  :service_access_role_arn,
  :authentication_method)
  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

Returns:

(Integer)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9341

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,
  :service_access_role_arn,
  :authentication_method)
  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

Returns:

(Integer)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9341

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

#password ⇒ `String`

Endpoint connection password.

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9341

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

#port ⇒ `Integer`

Endpoint TCP port.

Returns:

(Integer)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9341

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,
  :service_access_role_arn,
  :authentication_method)
  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.

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)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9341

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,
  :service_access_role_arn,
  :authentication_method)
  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.

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9341

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,
  :service_access_role_arn,
  :authentication_method)
  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.

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9341

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,
  :service_access_role_arn,
  :authentication_method)
  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.

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9341

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

#service_access_role_arn ⇒ `String`

The IAM role you can use to authenticate when connecting to your endpoint. Ensure to include iam:PassRole and rds-db:connect actions in permission policy.

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9341

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,
  :service_access_role_arn,
  :authentication_method)
  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

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9341

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

#username ⇒ `String`

Endpoint connection user name.

Returns:

(String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9341

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#after_connect_script ⇒ String

#authentication_method ⇒ String

#clean_source_metadata_on_mismatch ⇒ Boolean

#database_name ⇒ String

#events_poll_interval ⇒ Integer

#execute_timeout ⇒ Integer

#max_file_size ⇒ Integer

#parallel_load_threads ⇒ Integer

#password ⇒ String

#port ⇒ Integer

#secrets_manager_access_role_arn ⇒ String

#secrets_manager_secret_id ⇒ String

#server_name ⇒ String

#server_timezone ⇒ String

#service_access_role_arn ⇒ String

#target_db_type ⇒ String

#username ⇒ String

#after_connect_script ⇒ `String`

#authentication_method ⇒ `String`

#clean_source_metadata_on_mismatch ⇒ `Boolean`

#database_name ⇒ `String`

#events_poll_interval ⇒ `Integer`

#execute_timeout ⇒ `Integer`

#max_file_size ⇒ `Integer`

#parallel_load_threads ⇒ `Integer`

#password ⇒ `String`

#port ⇒ `Integer`

#secrets_manager_access_role_arn ⇒ `String`

#secrets_manager_secret_id ⇒ `String`

#server_name ⇒ `String`

#server_timezone ⇒ `String`

#service_access_role_arn ⇒ `String`

#target_db_type ⇒ `String`

#username ⇒ `String`