Class: Aws::DatabaseMigrationService::Types::IBMDb2Settings

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

Overview

Provides information that defines an IBM Db2 LUW endpoint.

Constant Summary collapse

SENSITIVE =
[:password]

Instance Attribute Summary collapse

Instance Attribute Details

#current_lsnString

For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.

Returns:

  • (String)


6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6322

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :load_timeout,
  :write_buffer_size,
  :max_file_size,
  :keep_csv_files)
  SENSITIVE = [:password]
  include Aws::Structure
end

#database_nameString

Database name for the endpoint.

Returns:

  • (String)


6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6322

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :load_timeout,
  :write_buffer_size,
  :max_file_size,
  :keep_csv_files)
  SENSITIVE = [:password]
  include Aws::Structure
end

#keep_csv_filesBoolean

If true, DMS saves any .csv files to the Db2 LUW target that were used to replicate data. DMS uses these files for analysis and troubleshooting.

The default value is false.

Returns:

  • (Boolean)


6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6322

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :load_timeout,
  :write_buffer_size,
  :max_file_size,
  :keep_csv_files)
  SENSITIVE = [:password]
  include Aws::Structure
end

#load_timeoutInteger

The amount of time (in milliseconds) before DMS times out operations performed by DMS on the Db2 target. The default value is 1200 (20 minutes).

Returns:

  • (Integer)


6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6322

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :load_timeout,
  :write_buffer_size,
  :max_file_size,
  :keep_csv_files)
  SENSITIVE = [:password]
  include Aws::Structure
end

#max_file_sizeInteger

Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.

Returns:

  • (Integer)


6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6322

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :load_timeout,
  :write_buffer_size,
  :max_file_size,
  :keep_csv_files)
  SENSITIVE = [:password]
  include Aws::Structure
end

#max_k_bytes_per_readInteger

Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.

Returns:

  • (Integer)


6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6322

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :load_timeout,
  :write_buffer_size,
  :max_file_size,
  :keep_csv_files)
  SENSITIVE = [:password]
  include Aws::Structure
end

#passwordString

Endpoint connection password.

Returns:

  • (String)


6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6322

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :load_timeout,
  :write_buffer_size,
  :max_file_size,
  :keep_csv_files)
  SENSITIVE = [:password]
  include Aws::Structure
end

#portInteger

Endpoint TCP port. The default value is 50000.

Returns:

  • (Integer)


6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6322

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :load_timeout,
  :write_buffer_size,
  :max_file_size,
  :keep_csv_files)
  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 Db2 LUW 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)


6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6322

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :load_timeout,
  :write_buffer_size,
  :max_file_size,
  :keep_csv_files)
  SENSITIVE = [:password]
  include Aws::Structure
end

#secrets_manager_secret_idString

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

Returns:

  • (String)


6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6322

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :load_timeout,
  :write_buffer_size,
  :max_file_size,
  :keep_csv_files)
  SENSITIVE = [:password]
  include Aws::Structure
end

#server_nameString

Fully qualified domain name of the endpoint.

Returns:

  • (String)


6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6322

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :load_timeout,
  :write_buffer_size,
  :max_file_size,
  :keep_csv_files)
  SENSITIVE = [:password]
  include Aws::Structure
end

#set_data_capture_changesBoolean

Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.

Returns:

  • (Boolean)


6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6322

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :load_timeout,
  :write_buffer_size,
  :max_file_size,
  :keep_csv_files)
  SENSITIVE = [:password]
  include Aws::Structure
end

#usernameString

Endpoint connection user name.

Returns:

  • (String)


6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6322

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :load_timeout,
  :write_buffer_size,
  :max_file_size,
  :keep_csv_files)
  SENSITIVE = [:password]
  include Aws::Structure
end

#write_buffer_sizeInteger

The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk on the DMS replication instance. The default value is 1024 (1 MB).

Returns:

  • (Integer)


6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6322

class IBMDb2Settings < Struct.new(
  :database_name,
  :password,
  :port,
  :server_name,
  :set_data_capture_changes,
  :current_lsn,
  :max_k_bytes_per_read,
  :username,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :load_timeout,
  :write_buffer_size,
  :max_file_size,
  :keep_csv_files)
  SENSITIVE = [:password]
  include Aws::Structure
end