Class: AWSCDK::DMS::CfnEndpoint::OracleSettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
dms/cfn_endpoint.rb

Overview

Provides information that defines an Oracle endpoint.

This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For information about other available settings, see Extra connection attributes when using Oracle as a source for AWS DMS and Extra connection attributes when using Oracle as a target for AWS DMS in the AWS Database Migration Service User Guide .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(access_alternate_directly: nil, additional_archived_log_dest_id: nil, add_supplemental_logging: nil, allow_select_nested_tables: nil, archived_log_dest_id: nil, archived_logs_only: nil, asm_password: nil, asm_server: nil, asm_user: nil, char_length_semantics: nil, direct_path_no_log: nil, direct_path_parallel_load: nil, enable_homogenous_tablespace: nil, extra_archived_log_dest_ids: nil, fail_tasks_on_lob_truncation: nil, number_datatype_scale: nil, oracle_path_prefix: nil, parallel_asm_read_threads: nil, read_ahead_blocks: nil, read_table_space_name: nil, replace_path_prefix: nil, retry_interval: nil, secrets_manager_access_role_arn: nil, secrets_manager_oracle_asm_access_role_arn: nil, secrets_manager_oracle_asm_secret_id: nil, secrets_manager_secret_id: nil, security_db_encryption: nil, security_db_encryption_name: nil, spatial_data_option_to_geo_json_function_name: nil, standby_delay_time: nil, use_alternate_folder_for_online: nil, use_b_file: nil, use_direct_path_full_load: nil, use_logminer_reader: nil, use_path_prefix: nil) ⇒ OracleSettingsProperty

Returns a new instance of OracleSettingsProperty.

Parameters:

  • access_alternate_directly (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    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.

  • additional_archived_log_dest_id (Numeric, nil) (defaults to: nil) —

    Set this attribute with ArchivedLogDestId in a primary/ standby setup.

  • add_supplemental_logging (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Set this attribute to set up table-level supplemental logging for the Oracle database.

  • allow_select_nested_tables (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • archived_log_dest_id (Numeric, nil) (defaults to: nil) —

    Specifies the ID of the destination for the archived redo logs.

  • archived_logs_only (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    When this field is set to True , AWS DMS only accesses the archived redo logs.

  • asm_password (String, nil) (defaults to: nil) —

    For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password.

  • asm_server (String, nil) (defaults to: nil) —

    For an Oracle source endpoint, your ASM server address.

  • asm_user (String, nil) (defaults to: nil) —

    For an Oracle source endpoint, your ASM user name.

  • char_length_semantics (String, nil) (defaults to: nil) —

    Specifies whether the length of a character column is in bytes or in characters.

  • direct_path_no_log (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    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.

  • direct_path_parallel_load (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    When set to true , this attribute specifies a parallel load when useDirectPathFullLoad is set to Y .

  • enable_homogenous_tablespace (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • extra_archived_log_dest_ids (Array<Numeric>, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies the IDs of one more destinations for one or more archived redo logs.

  • fail_tasks_on_lob_truncation (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    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 .

  • number_datatype_scale (Numeric, nil) (defaults to: nil) —

    Specifies the number scale.

  • oracle_path_prefix (String, nil) (defaults to: nil) —

    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.

  • parallel_asm_read_threads (Numeric, nil) (defaults to: nil) —

    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).

  • read_ahead_blocks (Numeric, nil) (defaults to: nil) —

    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).

  • read_table_space_name (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    When set to true , this attribute supports tablespace replication.

  • replace_path_prefix (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    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.

  • retry_interval (Numeric, nil) (defaults to: nil) —

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

  • secrets_manager_access_role_arn (String, nil) (defaults to: nil) —

    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret .

  • secrets_manager_oracle_asm_access_role_arn (String, nil) (defaults to: nil) —

    Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).

  • secrets_manager_oracle_asm_secret_id (String, nil) (defaults to: nil) —

    Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).

  • secrets_manager_secret_id (String, nil) (defaults to: nil) —

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

  • security_db_encryption (String, nil) (defaults to: nil) —

    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.

  • security_db_encryption_name (String, nil) (defaults to: nil) —

    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.

  • spatial_data_option_to_geo_json_function_name (String, nil) (defaults to: nil) —

    Use this attribute to convert SDO_GEOMETRY to GEOJSON format.

  • standby_delay_time (Numeric, nil) (defaults to: nil) —

    Use this attribute to specify a time in minutes for the delay in standby sync.

  • use_alternate_folder_for_online (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    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.

  • use_b_file (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Set this attribute to True to capture change data using the Binary Reader utility.

  • use_direct_path_full_load (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Set this attribute to True to have AWS DMS use a direct path full load.

  • use_logminer_reader (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Set this attribute to True to capture change data using the Oracle LogMiner utility (the default).

  • use_path_prefix (String, nil) (defaults to: nil) —

    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.



2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
 
# File 'dms/cfn_endpoint.rb', line 2504

def initialize(access_alternate_directly: nil, additional_archived_log_dest_id: nil, add_supplemental_logging: nil, allow_select_nested_tables: nil, archived_log_dest_id: nil, archived_logs_only: nil, asm_password: nil, asm_server: nil, asm_user: nil, char_length_semantics: nil, direct_path_no_log: nil, direct_path_parallel_load: nil, enable_homogenous_tablespace: nil, extra_archived_log_dest_ids: nil, fail_tasks_on_lob_truncation: nil, number_datatype_scale: nil, oracle_path_prefix: nil, parallel_asm_read_threads: nil, read_ahead_blocks: nil, read_table_space_name: nil, replace_path_prefix: nil, retry_interval: nil, secrets_manager_access_role_arn: nil, secrets_manager_oracle_asm_access_role_arn: nil, secrets_manager_oracle_asm_secret_id: nil, secrets_manager_secret_id: nil, security_db_encryption: nil, security_db_encryption_name: nil, spatial_data_option_to_geo_json_function_name: nil, standby_delay_time: nil, use_alternate_folder_for_online: nil, use_b_file: nil, use_direct_path_full_load: nil, use_logminer_reader: nil, use_path_prefix: nil)
  @access_alternate_directly = access_alternate_directly
  Jsii::Type.check_type(@access_alternate_directly, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "accessAlternateDirectly") unless @access_alternate_directly.nil?
  @additional_archived_log_dest_id = additional_archived_log_dest_id
  Jsii::Type.check_type(@additional_archived_log_dest_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "additionalArchivedLogDestId") unless @additional_archived_log_dest_id.nil?
  @add_supplemental_logging = add_supplemental_logging
  Jsii::Type.check_type(@add_supplemental_logging, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "addSupplementalLogging") unless @add_supplemental_logging.nil?
  @allow_select_nested_tables = allow_select_nested_tables
  Jsii::Type.check_type(@allow_select_nested_tables, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "allowSelectNestedTables") unless @allow_select_nested_tables.nil?
  @archived_log_dest_id = archived_log_dest_id
  Jsii::Type.check_type(@archived_log_dest_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "archivedLogDestId") unless @archived_log_dest_id.nil?
  @archived_logs_only = archived_logs_only
  Jsii::Type.check_type(@archived_logs_only, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "archivedLogsOnly") unless @archived_logs_only.nil?
  @asm_password = asm_password
  Jsii::Type.check_type(@asm_password, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "asmPassword") unless @asm_password.nil?
  @asm_server = asm_server
  Jsii::Type.check_type(@asm_server, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "asmServer") unless @asm_server.nil?
  @asm_user = asm_user
  Jsii::Type.check_type(@asm_user, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "asmUser") unless @asm_user.nil?
  @char_length_semantics = char_length_semantics
  Jsii::Type.check_type(@char_length_semantics, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "charLengthSemantics") unless @char_length_semantics.nil?
  @direct_path_no_log = direct_path_no_log
  Jsii::Type.check_type(@direct_path_no_log, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "directPathNoLog") unless @direct_path_no_log.nil?
  @direct_path_parallel_load = direct_path_parallel_load
  Jsii::Type.check_type(@direct_path_parallel_load, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "directPathParallelLoad") unless @direct_path_parallel_load.nil?
  @enable_homogenous_tablespace = enable_homogenous_tablespace
  Jsii::Type.check_type(@enable_homogenous_tablespace, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableHomogenousTablespace") unless @enable_homogenous_tablespace.nil?
  @extra_archived_log_dest_ids = extra_archived_log_dest_ids
  Jsii::Type.check_type(@extra_archived_log_dest_ids, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siY29sbGVjdGlvbiI6eyJlbGVtZW50dHlwZSI6eyJwcmltaXRpdmUiOiJudW1iZXIifSwia2luZCI6ImFycmF5In19LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "extraArchivedLogDestIds") unless @extra_archived_log_dest_ids.nil?
  @fail_tasks_on_lob_truncation = fail_tasks_on_lob_truncation
  Jsii::Type.check_type(@fail_tasks_on_lob_truncation, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "failTasksOnLobTruncation") unless @fail_tasks_on_lob_truncation.nil?
  @number_datatype_scale = number_datatype_scale
  Jsii::Type.check_type(@number_datatype_scale, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "numberDatatypeScale") unless @number_datatype_scale.nil?
  @oracle_path_prefix = oracle_path_prefix
  Jsii::Type.check_type(@oracle_path_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "oraclePathPrefix") unless @oracle_path_prefix.nil?
  @parallel_asm_read_threads = parallel_asm_read_threads
  Jsii::Type.check_type(@parallel_asm_read_threads, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "parallelAsmReadThreads") unless @parallel_asm_read_threads.nil?
  @read_ahead_blocks = read_ahead_blocks
  Jsii::Type.check_type(@read_ahead_blocks, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "readAheadBlocks") unless @read_ahead_blocks.nil?
  @read_table_space_name = read_table_space_name
  Jsii::Type.check_type(@read_table_space_name, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "readTableSpaceName") unless @read_table_space_name.nil?
  @replace_path_prefix = replace_path_prefix
  Jsii::Type.check_type(@replace_path_prefix, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "replacePathPrefix") unless @replace_path_prefix.nil?
  @retry_interval = retry_interval
  Jsii::Type.check_type(@retry_interval, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "retryInterval") unless @retry_interval.nil?
  @secrets_manager_access_role_arn = secrets_manager_access_role_arn
  Jsii::Type.check_type(@secrets_manager_access_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretsManagerAccessRoleArn") unless @secrets_manager_access_role_arn.nil?
  @secrets_manager_oracle_asm_access_role_arn = secrets_manager_oracle_asm_access_role_arn
  Jsii::Type.check_type(@secrets_manager_oracle_asm_access_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretsManagerOracleAsmAccessRoleArn") unless @secrets_manager_oracle_asm_access_role_arn.nil?
  @secrets_manager_oracle_asm_secret_id = secrets_manager_oracle_asm_secret_id
  Jsii::Type.check_type(@secrets_manager_oracle_asm_secret_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretsManagerOracleAsmSecretId") unless @secrets_manager_oracle_asm_secret_id.nil?
  @secrets_manager_secret_id = secrets_manager_secret_id
  Jsii::Type.check_type(@secrets_manager_secret_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretsManagerSecretId") unless @secrets_manager_secret_id.nil?
  @security_db_encryption = security_db_encryption
  Jsii::Type.check_type(@security_db_encryption, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "securityDbEncryption") unless @security_db_encryption.nil?
  @security_db_encryption_name = security_db_encryption_name
  Jsii::Type.check_type(@security_db_encryption_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "securityDbEncryptionName") unless @security_db_encryption_name.nil?
  @spatial_data_option_to_geo_json_function_name = spatial_data_option_to_geo_json_function_name
  Jsii::Type.check_type(@spatial_data_option_to_geo_json_function_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "spatialDataOptionToGeoJsonFunctionName") unless @spatial_data_option_to_geo_json_function_name.nil?
  @standby_delay_time = standby_delay_time
  Jsii::Type.check_type(@standby_delay_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "standbyDelayTime") unless @standby_delay_time.nil?
  @use_alternate_folder_for_online = use_alternate_folder_for_online
  Jsii::Type.check_type(@use_alternate_folder_for_online, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "useAlternateFolderForOnline") unless @use_alternate_folder_for_online.nil?
  @use_b_file = use_b_file
  Jsii::Type.check_type(@use_b_file, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "useBFile") unless @use_b_file.nil?
  @use_direct_path_full_load = use_direct_path_full_load
  Jsii::Type.check_type(@use_direct_path_full_load, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "useDirectPathFullLoad") unless @use_direct_path_full_load.nil?
  @use_logminer_reader = use_logminer_reader
  Jsii::Type.check_type(@use_logminer_reader, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "useLogminerReader") unless @use_logminer_reader.nil?
  @use_path_prefix = use_path_prefix
  Jsii::Type.check_type(@use_path_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "usePathPrefix") unless @use_path_prefix.nil?
end

Instance Attribute Details

#access_alternate_directly ⇒ Boolean, ... (readonly)

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:

See Also:



2583
2584
2585
 
# File 'dms/cfn_endpoint.rb', line 2583

def access_alternate_directly
  @access_alternate_directly
end

#add_supplemental_logging ⇒ Boolean, ... (readonly)

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:

See Also:



2601
2602
2603
 
# File 'dms/cfn_endpoint.rb', line 2601

def add_supplemental_logging
  @add_supplemental_logging
end

#additional_archived_log_dest_id ⇒ Numeric? (readonly)

Set this attribute with ArchivedLogDestId in a primary/ standby setup.

This attribute is useful in the case of a switchover. In this case, AWS 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 AWS 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:

  • (Numeric, nil)

See Also:



2592
2593
2594
 
# File 'dms/cfn_endpoint.rb', line 2592

def additional_archived_log_dest_id
  @additional_archived_log_dest_id
end

#allow_select_nested_tables ⇒ Boolean, ... (readonly)

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

Returns:

See Also:



2606
2607
2608
 
# File 'dms/cfn_endpoint.rb', line 2606

def allow_select_nested_tables
  @allow_select_nested_tables
end

#archived_log_dest_id ⇒ Numeric? (readonly)

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:

  • (Numeric, nil)

See Also:



2613
2614
2615
 
# File 'dms/cfn_endpoint.rb', line 2613

def archived_log_dest_id
  @archived_log_dest_id
end

#archived_logs_only ⇒ Boolean, ... (readonly)

When this field is set to True , AWS DMS only accesses the archived redo logs.

If the archived redo logs are stored on Automatic Storage Management (ASM) only, the AWS DMS user account needs to be granted ASM privileges.

Returns:

See Also:



2620
2621
2622
 
# File 'dms/cfn_endpoint.rb', line 2620

def archived_logs_only
  @archived_logs_only
end

#asm_password ⇒ String? (readonly)

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, nil)

See Also:



2627
2628
2629
 
# File 'dms/cfn_endpoint.rb', line 2627

def asm_password
  @asm_password
end

#asm_server ⇒ String? (readonly)

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, nil)

See Also:



2634
2635
2636
 
# File 'dms/cfn_endpoint.rb', line 2634

def asm_server
  @asm_server
end

#asm_user ⇒ String? (readonly)

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, nil)

See Also:



2641
2642
2643
 
# File 'dms/cfn_endpoint.rb', line 2641

def asm_user
  @asm_user
end

#char_length_semantics ⇒ String? (readonly)

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, nil)

See Also:



2650
2651
2652
 
# File 'dms/cfn_endpoint.rb', line 2650

def char_length_semantics
  @char_length_semantics
end

#direct_path_no_log ⇒ Boolean, ... (readonly)

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:

See Also:



2655
2656
2657
 
# File 'dms/cfn_endpoint.rb', line 2655

def direct_path_no_log
  @direct_path_no_log
end

#direct_path_parallel_load ⇒ Boolean, ... (readonly)

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 AWS DMS parallel load feature. Note that the target table cannot have any constraints or indexes.

Returns:

See Also:



2662
2663
2664
 
# File 'dms/cfn_endpoint.rb', line 2662

def direct_path_parallel_load
  @direct_path_parallel_load
end

#enable_homogenous_tablespace ⇒ Boolean, ... (readonly)

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

Returns:

See Also:



2667
2668
2669
 
# File 'dms/cfn_endpoint.rb', line 2667

def enable_homogenous_tablespace
  @enable_homogenous_tablespace
end

#extra_archived_log_dest_ids ⇒ Array<Numeric>, ... (readonly)

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 archived_log_dest_id 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, AWS DMS needs information about what destination to get archive redo logs from to read changes. AWS 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 AWS 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:

See Also:



2684
2685
2686
 
# File 'dms/cfn_endpoint.rb', line 2684

def extra_archived_log_dest_ids
  @extra_archived_log_dest_ids
end

#fail_tasks_on_lob_truncation ⇒ Boolean, ... (readonly)

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:

See Also:



2691
2692
2693
 
# File 'dms/cfn_endpoint.rb', line 2691

def fail_tasks_on_lob_truncation
  @fail_tasks_on_lob_truncation
end

#number_datatype_scale ⇒ Numeric? (readonly)

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:

  • (Numeric, nil)

See Also:



2700
2701
2702
 
# File 'dms/cfn_endpoint.rb', line 2700

def number_datatype_scale
  @number_datatype_scale
end

#oracle_path_prefix ⇒ String? (readonly)

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, nil)

See Also:



2707
2708
2709
 
# File 'dms/cfn_endpoint.rb', line 2707

def oracle_path_prefix
  @oracle_path_prefix
end

#parallel_asm_read_threads ⇒ Numeric? (readonly)

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 read_ahead_blocks attribute.

Returns:

  • (Numeric, nil)

See Also:



2714
2715
2716
 
# File 'dms/cfn_endpoint.rb', line 2714

def parallel_asm_read_threads
  @parallel_asm_read_threads
end

#read_ahead_blocks ⇒ Numeric? (readonly)

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:

  • (Numeric, nil)

See Also:



2721
2722
2723
 
# File 'dms/cfn_endpoint.rb', line 2721

def read_ahead_blocks
  @read_ahead_blocks
end

#read_table_space_name ⇒ Boolean, ... (readonly)

When set to true , this attribute supports tablespace replication.

Returns:

See Also:



2726
2727
2728
 
# File 'dms/cfn_endpoint.rb', line 2726

def read_table_space_name
  @read_table_space_name
end

#replace_path_prefix ⇒ Boolean, ... (readonly)

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 use_path_prefix setting to access the redo logs.

Returns:

See Also:



2733
2734
2735
 
# File 'dms/cfn_endpoint.rb', line 2733

def replace_path_prefix
  @replace_path_prefix
end

#retry_interval ⇒ Numeric? (readonly)

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

Example: retryInterval=6;

Returns:

  • (Numeric, nil)

See Also:



2740
2741
2742
 
# File 'dms/cfn_endpoint.rb', line 2740

def retry_interval
  @retry_interval
end

#secrets_manager_access_role_arn ⇒ String? (readonly)

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS 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 , the corresponding SecretsManagerAccessRoleArn , and the SecretsManagerSecretId that is required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide .

Returns:

  • (String, nil)

See Also:



2751
2752
2753
 
# File 'dms/cfn_endpoint.rb', line 2751

def secrets_manager_access_role_arn
  @secrets_manager_access_role_arn
end

#secrets_manager_oracle_asm_access_role_arn ⇒ String? (readonly)

Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).

The full ARN of the IAM role that specifies AWS 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 , the corresponding SecretsManagerOracleAsmAccessRoleArn , and the SecretsManagerOracleAsmSecretId that is required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide .

Returns:

  • (String, nil)

See Also:



2762
2763
2764
 
# File 'dms/cfn_endpoint.rb', line 2762

def secrets_manager_oracle_asm_access_role_arn
  @secrets_manager_oracle_asm_access_role_arn
end

#secrets_manager_oracle_asm_secret_id ⇒ String? (readonly)

Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).

The full ARN, partial ARN, or display name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.

Returns:

  • (String, nil)

See Also:



2769
2770
2771
 
# File 'dms/cfn_endpoint.rb', line 2769

def secrets_manager_oracle_asm_secret_id
  @secrets_manager_oracle_asm_secret_id
end

#secrets_manager_secret_id ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



2774
2775
2776
 
# File 'dms/cfn_endpoint.rb', line 2774

def secrets_manager_secret_id
  @secrets_manager_secret_id
end

#security_db_encryption ⇒ String? (readonly)

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 AWS DMS in the AWS Database Migration Service User Guide .

Returns:

  • (String, nil)

See Also:



2781
2782
2783
 
# File 'dms/cfn_endpoint.rb', line 2781

def security_db_encryption
  @security_db_encryption
end

#security_db_encryption_name ⇒ String? (readonly)

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 security_db_encryption_name extra connection attribute in Supported encryption methods for using Oracle as a source for AWS DMS in the AWS Database Migration Service User Guide .

Returns:

  • (String, nil)

See Also:



2788
2789
2790
 
# File 'dms/cfn_endpoint.rb', line 2788

def security_db_encryption_name
  @security_db_encryption_name
end

#spatial_data_option_to_geo_json_function_name ⇒ String? (readonly)

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, nil)

See Also:



2795
2796
2797
 
# File 'dms/cfn_endpoint.rb', line 2795

def spatial_data_option_to_geo_json_function_name
  @spatial_data_option_to_geo_json_function_name
end

#standby_delay_time ⇒ Numeric? (readonly)

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 AWS 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:

  • (Numeric, nil)

See Also:



2804
2805
2806
 
# File 'dms/cfn_endpoint.rb', line 2804

def standby_delay_time
  @standby_delay_time
end

#use_alternate_folder_for_online ⇒ Boolean, ... (readonly)

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:

See Also:



2811
2812
2813
 
# File 'dms/cfn_endpoint.rb', line 2811

def use_alternate_folder_for_online
  @use_alternate_folder_for_online
end

#use_b_file ⇒ Boolean, ... (readonly)

Set this attribute to True to capture change data using the Binary Reader utility.

Set UseLogminerReader to False to set this attribute to True. 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 AWS DMS Binary Reader for CDC .

Returns:

See Also:



2818
2819
2820
 
# File 'dms/cfn_endpoint.rb', line 2818

def use_b_file
  @use_b_file
end

#use_direct_path_full_load ⇒ Boolean, ... (readonly)

Set this attribute to True to have AWS 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:

See Also:



2825
2826
2827
 
# File 'dms/cfn_endpoint.rb', line 2825

def use_direct_path_full_load
  @use_direct_path_full_load
end

#use_logminer_reader ⇒ Boolean, ... (readonly)

Set this attribute to True to capture change data using the Oracle LogMiner utility (the default).

Set this attribute to False if you want to access the redo logs as a binary file. When you set UseLogminerReader to False, also set UseBfile to True. For more information on this setting and using Oracle ASM, see Using Oracle LogMiner or AWS DMS Binary Reader for CDC in the AWS DMS User Guide .

Returns:

See Also:



2832
2833
2834
 
# File 'dms/cfn_endpoint.rb', line 2832

def use_logminer_reader
  @use_logminer_reader
end

#use_path_prefix ⇒ String? (readonly)

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, nil)

See Also:



2839
2840
2841
 
# File 'dms/cfn_endpoint.rb', line 2839

def use_path_prefix
  @use_path_prefix
end

Class Method Details

.jsii_properties ⇒ Object 



2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
 
# File 'dms/cfn_endpoint.rb', line 2841

def self.jsii_properties
  {
    :access_alternate_directly => "accessAlternateDirectly",
    :additional_archived_log_dest_id => "additionalArchivedLogDestId",
    :add_supplemental_logging => "addSupplementalLogging",
    :allow_select_nested_tables => "allowSelectNestedTables",
    :archived_log_dest_id => "archivedLogDestId",
    :archived_logs_only => "archivedLogsOnly",
    :asm_password => "asmPassword",
    :asm_server => "asmServer",
    :asm_user => "asmUser",
    :char_length_semantics => "charLengthSemantics",
    :direct_path_no_log => "directPathNoLog",
    :direct_path_parallel_load => "directPathParallelLoad",
    :enable_homogenous_tablespace => "enableHomogenousTablespace",
    :extra_archived_log_dest_ids => "extraArchivedLogDestIds",
    :fail_tasks_on_lob_truncation => "failTasksOnLobTruncation",
    :number_datatype_scale => "numberDatatypeScale",
    :oracle_path_prefix => "oraclePathPrefix",
    :parallel_asm_read_threads => "parallelAsmReadThreads",
    :read_ahead_blocks => "readAheadBlocks",
    :read_table_space_name => "readTableSpaceName",
    :replace_path_prefix => "replacePathPrefix",
    :retry_interval => "retryInterval",
    :secrets_manager_access_role_arn => "secretsManagerAccessRoleArn",
    :secrets_manager_oracle_asm_access_role_arn => "secretsManagerOracleAsmAccessRoleArn",
    :secrets_manager_oracle_asm_secret_id => "secretsManagerOracleAsmSecretId",
    :secrets_manager_secret_id => "secretsManagerSecretId",
    :security_db_encryption => "securityDbEncryption",
    :security_db_encryption_name => "securityDbEncryptionName",
    :spatial_data_option_to_geo_json_function_name => "spatialDataOptionToGeoJsonFunctionName",
    :standby_delay_time => "standbyDelayTime",
    :use_alternate_folder_for_online => "useAlternateFolderForOnline",
    :use_b_file => "useBFile",
    :use_direct_path_full_load => "useDirectPathFullLoad",
    :use_logminer_reader => "useLogminerReader",
    :use_path_prefix => "usePathPrefix",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
 
# File 'dms/cfn_endpoint.rb', line 2881

def to_jsii
  result = {}
  result.merge!({
    "accessAlternateDirectly" => @access_alternate_directly,
    "additionalArchivedLogDestId" => @additional_archived_log_dest_id,
    "addSupplementalLogging" => @add_supplemental_logging,
    "allowSelectNestedTables" => @allow_select_nested_tables,
    "archivedLogDestId" => @archived_log_dest_id,
    "archivedLogsOnly" => @archived_logs_only,
    "asmPassword" => @asm_password,
    "asmServer" => @asm_server,
    "asmUser" => @asm_user,
    "charLengthSemantics" => @char_length_semantics,
    "directPathNoLog" => @direct_path_no_log,
    "directPathParallelLoad" => @direct_path_parallel_load,
    "enableHomogenousTablespace" => @enable_homogenous_tablespace,
    "extraArchivedLogDestIds" => @extra_archived_log_dest_ids,
    "failTasksOnLobTruncation" => @fail_tasks_on_lob_truncation,
    "numberDatatypeScale" => @number_datatype_scale,
    "oraclePathPrefix" => @oracle_path_prefix,
    "parallelAsmReadThreads" => @parallel_asm_read_threads,
    "readAheadBlocks" => @read_ahead_blocks,
    "readTableSpaceName" => @read_table_space_name,
    "replacePathPrefix" => @replace_path_prefix,
    "retryInterval" => @retry_interval,
    "secretsManagerAccessRoleArn" => @secrets_manager_access_role_arn,
    "secretsManagerOracleAsmAccessRoleArn" => @secrets_manager_oracle_asm_access_role_arn,
    "secretsManagerOracleAsmSecretId" => @secrets_manager_oracle_asm_secret_id,
    "secretsManagerSecretId" => @secrets_manager_secret_id,
    "securityDbEncryption" => @security_db_encryption,
    "securityDbEncryptionName" => @security_db_encryption_name,
    "spatialDataOptionToGeoJsonFunctionName" => @spatial_data_option_to_geo_json_function_name,
    "standbyDelayTime" => @standby_delay_time,
    "useAlternateFolderForOnline" => @use_alternate_folder_for_online,
    "useBFile" => @use_b_file,
    "useDirectPathFullLoad" => @use_direct_path_full_load,
    "useLogminerReader" => @use_logminer_reader,
    "usePathPrefix" => @use_path_prefix,
  })
  result.compact
end