You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DatabaseMigrationService::Types::MicrosoftSQLServerSettings

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing MicrosoftSQLServerSettings as input to an Aws::Client method, you can use a vanilla Hash:

{
  port: 1,
  bcp_packet_size: 1,
  database_name: "String",
  control_tables_file_group: "String",
  password: "SecretString",
  read_backup_only: false,
  safeguard_policy: "rely-on-sql-server-replication-agent", # accepts rely-on-sql-server-replication-agent, exclusive-automatic-truncation, shared-automatic-truncation
  server_name: "String",
  username: "String",
  use_bcp_full_load: false,
}

Provides information that defines a Microsoft SQL Server endpoint.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bcp_packet_size ⇒ Integer

The maximum size of the packets (in bytes) used to transfer data using BCP.

Returns:

  • (Integer) —

    The maximum size of the packets (in bytes) used to transfer data using BCP.

#control_tables_file_group ⇒ String

Specify a filegroup for the AWS DMS internal tables. When the replication task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created on the specified filegroup.

Returns:

  • (String) —

    Specify a filegroup for the AWS DMS internal tables.

#database_name ⇒ String

Database name for the endpoint.

Returns:

  • (String) —

    Database name for the endpoint.

#password ⇒ String

Endpoint connection password.

Returns:

  • (String) —

    Endpoint connection password.

#port ⇒ Integer

Endpoint TCP port.

Returns:

  • (Integer) —

    Endpoint TCP port.

#read_backup_only ⇒ Boolean

When this attribute is set to Y, AWS DMS only reads changes from transaction log backups and doesn\'t read from the active transaction log file during ongoing replication. Setting this parameter to Y enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication.

Returns:

  • (Boolean) —

    When this attribute is set to Y, AWS DMS only reads changes from transaction log backups and doesn\'t read from the active transaction log file during ongoing replication.

#safeguard_policy ⇒ String

Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.

Start transactions in the database: This is the default method. When this method is used, AWS DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren\'t truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.

Exclusively use sp_repldone within a single task: When this method is used, AWS DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn\'t involve any transactional activities, it can only be used when Microsoft Replication isn\'t running. Also, when using this method, only one AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method.

Possible values:

  • rely-on-sql-server-replication-agent
  • exclusive-automatic-truncation
  • shared-automatic-truncation

Returns:

  • (String) —

    Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.

#server_name ⇒ String

Fully qualified domain name of the endpoint.

Returns:

  • (String) —

    Fully qualified domain name of the endpoint.

#use_bcp_full_load ⇒ Boolean

Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.

Returns:

  • (Boolean) —

    Use this to attribute to transfer data for full-load operations using BCP.

#username ⇒ String

Endpoint connection user name.

Returns:

  • (String) —

    Endpoint connection user name.