Class: Aws::DatabaseMigrationService::Types::OracleSettings

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

Overview

Provides information that defines an Oracle endpoint.

Constant Summary collapse

SENSITIVE =
[:asm_password, :password, :security_db_encryption]

Instance Attribute Summary collapse

Instance Attribute Details

#access_alternate_directlyBoolean

Set this attribute to false in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This tells the DMS instance to not access redo logs through any specified path prefix replacement using direct file access.

Returns:

  • (Boolean)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#add_supplemental_loggingBoolean

Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute enables PRIMARY KEY supplemental logging on all tables selected for a migration task.

If you use this option, you still need to enable database-level supplemental logging.

Returns:

  • (Boolean)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#additional_archived_log_dest_idInteger

Set this attribute with ArchivedLogDestId in a primary/ standby setup. This attribute is useful in the case of a switchover. In this case, DMS needs to know which destination to get archive redo logs from to read changes. This need arises because the previous primary instance is now a standby instance after switchover.

Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use RESETLOGS unless necessary. For additional information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.

Returns:

  • (Integer)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#allow_select_nested_tablesBoolean

Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.

Returns:

  • (Boolean)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#archived_log_dest_idInteger

Specifies the ID of the destination for the archived redo logs. This value should be the same as a number in the dest_id column of the v$archived_log view. If you work with an additional redo log destination, use the AdditionalArchivedLogDestId option to specify the additional destination ID. Doing this improves performance by ensuring that the correct logs are accessed from the outset.

Returns:

  • (Integer)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#archived_logs_onlyBoolean

When this field is set to Y, DMS only accesses the archived redo logs. If the archived redo logs are stored on Automatic Storage Management (ASM) only, the DMS user account needs to be granted ASM privileges.

Returns:

  • (Boolean)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#asm_passwordString

For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value from the asm_user_password value. You set this value as part of the comma-separated value that you set to the Password request parameter when you create the endpoint to access transaction logs using Binary Reader. For more information, see Configuration for change data capture (CDC) on an Oracle source database.

Returns:

  • (String)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#asm_serverString

For an Oracle source endpoint, your ASM server address. You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.

Returns:

  • (String)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#asm_userString

For an Oracle source endpoint, your ASM user name. You can set this value from the asm_user value. You set asm_user as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.

Returns:

  • (String)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#char_length_semanticsString

Specifies whether the length of a character column is in bytes or in characters. To indicate that the character column length is in characters, set this attribute to CHAR. Otherwise, the character column length is in bytes.

Example: charLengthSemantics=CHAR;

Returns:

  • (String)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#convert_timestamp_with_zone_to_utcBoolean

When true, converts timestamps with the timezone datatype to their UTC value.

Returns:

  • (Boolean)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#database_nameString

Database name for the endpoint.

Returns:

  • (String)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#direct_path_no_logBoolean

When set to true, this attribute helps to increase the commit rate on the Oracle target database by writing directly to tables and not writing a trail to database logs.

Returns:

  • (Boolean)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#direct_path_parallel_loadBoolean

When set to true, this attribute specifies a parallel load when useDirectPathFullLoad is set to Y. This attribute also only applies when you use the DMS parallel load feature. Note that the target table cannot have any constraints or indexes.

Returns:

  • (Boolean)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#enable_homogenous_tablespaceBoolean

Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.

Returns:

  • (Boolean)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#extra_archived_log_dest_idsArray<Integer>

Specifies the IDs of one more destinations for one or more archived redo logs. These IDs are the values of the dest_id column in the v$archived_log view. Use this setting with the archivedLogDestId extra connection attribute in a primary-to-single setup or a primary-to-multiple-standby setup.

This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this case, DMS needs information about what destination to get archive redo logs from to read changes. DMS needs this because after the switchover the previous primary is a standby instance. For example, in a primary-to-single standby setup you might apply the following settings.

archivedLogDestId=1; ExtraArchivedLogDestIds=[2]

In a primary-to-multiple-standby setup, you might apply the following settings.

archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]

Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use RESETLOGS unless it's necessary. For more information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.

Returns:

  • (Array<Integer>)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#fail_tasks_on_lob_truncationBoolean

When set to true, this attribute causes a task to fail if the actual size of an LOB column is greater than the specified LobMaxSize.

If a task is set to limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.

Returns:

  • (Boolean)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#number_datatype_scaleInteger

Specifies the number scale. You can select a scale up to 38, or you can select FLOAT. By default, the NUMBER data type is converted to precision 38, scale 10.

Example: numberDataTypeScale=12

Returns:

  • (Integer)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#open_transaction_windowInteger

The timeframe in minutes to check for open transactions for a CDC-only task.

You can specify an integer value between 0 (the default) and 240 (the maximum).

This parameter is only valid in DMS version 3.5.0 and later. DMS supports a window of up to 9.5 hours including the value for OpenTransactionWindow.

Returns:

  • (Integer)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#oracle_path_prefixString

Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the default Oracle root used to access the redo logs.

Returns:

  • (String)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#parallel_asm_read_threadsInteger

Set this attribute to change the number of threads that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 2 (the default) and 8 (the maximum). Use this attribute together with the readAheadBlocks attribute.

Returns:

  • (Integer)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#passwordString

Endpoint connection password.

Returns:

  • (String)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#portInteger

Endpoint TCP port.

Returns:

  • (Integer)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#read_ahead_blocksInteger

Set this attribute to change the number of read-ahead blocks that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 1000 (the default) and 200,000 (the maximum).

Returns:

  • (Integer)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#read_table_space_nameBoolean

When set to true, this attribute supports tablespace replication.

Returns:

  • (Boolean)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#replace_path_prefixBoolean

Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This setting tells DMS instance to replace the default Oracle root with the specified usePathPrefix setting to access the redo logs.

Returns:

  • (Boolean)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#retry_intervalInteger

Specifies the number of seconds that the system waits before resending a query.

Example: retryInterval=6;

Returns:

  • (Integer)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  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 Oracle 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)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#secrets_manager_oracle_asm_access_role_arnString

Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the SecretsManagerOracleAsmSecret. This SecretsManagerOracleAsmSecret has the secret value that allows access to the Oracle ASM of the endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerOracleAsmSecretId. Or you can specify clear-text values for AsmUser, AsmPassword, and AsmServerName. You can't specify both. For more information on creating this SecretsManagerOracleAsmSecret and the SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

Returns:

  • (String)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#secrets_manager_oracle_asm_secret_idString

Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.

Returns:

  • (String)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#secrets_manager_secret_idString

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

Returns:

  • (String)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#security_db_encryptionString

For an Oracle source endpoint, the transparent data encryption (TDE) password required by AWM DMS to access Oracle redo logs encrypted by TDE using Binary Reader. It is also the TDE_Password part of the comma-separated value you set to the Password request parameter when you create the endpoint. The SecurityDbEncryptian setting is related to this SecurityDbEncryptionName setting. For more information, see Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide.

Returns:

  • (String)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#security_db_encryption_nameString

For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns and tablespaces in an Oracle source database that is encrypted using TDE. The key value is the value of the SecurityDbEncryption setting. For more information on setting the key name value of SecurityDbEncryptionName, see the information and example for setting the securityDbEncryptionName extra connection attribute in Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide.

Returns:

  • (String)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#server_nameString

Fully qualified domain name of the endpoint.

For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.

Returns:

  • (String)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#spatial_data_option_to_geo_json_function_nameString

Use this attribute to convert SDO_GEOMETRY to GEOJSON format. By default, DMS calls the SDO2GEOJSON custom function if present and accessible. Or you can create your own custom function that mimics the operation of SDOGEOJSON and set SpatialDataOptionToGeoJsonFunctionName to call it instead.

Returns:

  • (String)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#standby_delay_timeInteger

Use this attribute to specify a time in minutes for the delay in standby sync. If the source is an Oracle Active Data Guard standby database, use this attribute to specify the time lag between primary and standby databases.

In DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for replicating ongoing changes. Doing this eliminates the need to connect to an active database that might be in production.

Returns:

  • (Integer)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#trim_space_in_charBoolean

Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is true.

Returns:

  • (Boolean)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#use_alternate_folder_for_onlineBoolean

Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This tells the DMS instance to use any specified prefix replacement to access all online redo logs.

Returns:

  • (Boolean)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#use_b_fileBoolean

Set this attribute to Y to capture change data using the Binary Reader utility. Set UseLogminerReader to N to set this attribute to Y. To use Binary Reader with Amazon RDS for Oracle as the source, you set additional attributes. For more information about using this setting with Oracle Automatic Storage Management (ASM), see Using Oracle LogMiner or DMS Binary Reader for CDC.

Returns:

  • (Boolean)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#use_direct_path_full_loadBoolean

Set this attribute to Y to have DMS use a direct path full load. Specify this value to use the direct path protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle target tables during a full load.

Returns:

  • (Boolean)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#use_logminer_readerBoolean

Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default). Set this attribute to N if you want to access the redo logs as a binary file. When you set UseLogminerReader to N, also set UseBfile to Y. For more information on this setting and using Oracle ASM, see Using Oracle LogMiner or DMS Binary Reader for CDC in the DMS User Guide.

Returns:

  • (Boolean)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#use_path_prefixString

Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the path prefix used to replace the default Oracle root to access the redo logs.

Returns:

  • (String)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end

#usernameString

Endpoint connection user name.

Returns:

  • (String)


9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 9324

class OracleSettings < Struct.new(
  :add_supplemental_logging,
  :archived_log_dest_id,
  :additional_archived_log_dest_id,
  :extra_archived_log_dest_ids,
  :allow_select_nested_tables,
  :parallel_asm_read_threads,
  :read_ahead_blocks,
  :access_alternate_directly,
  :use_alternate_folder_for_online,
  :oracle_path_prefix,
  :use_path_prefix,
  :replace_path_prefix,
  :enable_homogenous_tablespace,
  :direct_path_no_log,
  :archived_logs_only,
  :asm_password,
  :asm_server,
  :asm_user,
  :char_length_semantics,
  :database_name,
  :direct_path_parallel_load,
  :fail_tasks_on_lob_truncation,
  :number_datatype_scale,
  :password,
  :port,
  :read_table_space_name,
  :retry_interval,
  :security_db_encryption,
  :security_db_encryption_name,
  :server_name,
  :spatial_data_option_to_geo_json_function_name,
  :standby_delay_time,
  :username,
  :use_b_file,
  :use_direct_path_full_load,
  :use_logminer_reader,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :secrets_manager_oracle_asm_access_role_arn,
  :secrets_manager_oracle_asm_secret_id,
  :trim_space_in_char,
  :convert_timestamp_with_zone_to_utc,
  :open_transaction_window)
  SENSITIVE = [:asm_password, :password, :security_db_encryption]
  include Aws::Structure
end