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

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

Overview

Note:

When making an API call, you may pass MicrosoftSQLServerSettings data as a 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.

Constant Summary collapse

SENSITIVE =
[:password]

Instance Attribute Summary collapse

Instance Attribute Details

#bcp_packet_sizeInteger

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

Returns:

  • (Integer)


4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4242

class MicrosoftSQLServerSettings < Struct.new(
  :port,
  :bcp_packet_size,
  :database_name,
  :control_tables_file_group,
  :password,
  :read_backup_only,
  :safeguard_policy,
  :server_name,
  :username,
  :use_bcp_full_load)
  SENSITIVE = [:password]
  include Aws::Structure
end

#control_tables_file_groupString

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)


4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4242

class MicrosoftSQLServerSettings < Struct.new(
  :port,
  :bcp_packet_size,
  :database_name,
  :control_tables_file_group,
  :password,
  :read_backup_only,
  :safeguard_policy,
  :server_name,
  :username,
  :use_bcp_full_load)
  SENSITIVE = [:password]
  include Aws::Structure
end

#database_nameString

Database name for the endpoint.

Returns:

  • (String)


4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4242

class MicrosoftSQLServerSettings < Struct.new(
  :port,
  :bcp_packet_size,
  :database_name,
  :control_tables_file_group,
  :password,
  :read_backup_only,
  :safeguard_policy,
  :server_name,
  :username,
  :use_bcp_full_load)
  SENSITIVE = [:password]
  include Aws::Structure
end

#passwordString

Endpoint connection password.

Returns:

  • (String)


4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4242

class MicrosoftSQLServerSettings < Struct.new(
  :port,
  :bcp_packet_size,
  :database_name,
  :control_tables_file_group,
  :password,
  :read_backup_only,
  :safeguard_policy,
  :server_name,
  :username,
  :use_bcp_full_load)
  SENSITIVE = [:password]
  include Aws::Structure
end

#portInteger

Endpoint TCP port.

Returns:

  • (Integer)


4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4242

class MicrosoftSQLServerSettings < Struct.new(
  :port,
  :bcp_packet_size,
  :database_name,
  :control_tables_file_group,
  :password,
  :read_backup_only,
  :safeguard_policy,
  :server_name,
  :username,
  :use_bcp_full_load)
  SENSITIVE = [:password]
  include Aws::Structure
end

#read_backup_onlyBoolean

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)


4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4242

class MicrosoftSQLServerSettings < Struct.new(
  :port,
  :bcp_packet_size,
  :database_name,
  :control_tables_file_group,
  :password,
  :read_backup_only,
  :safeguard_policy,
  :server_name,
  :username,
  :use_bcp_full_load)
  SENSITIVE = [:password]
  include Aws::Structure
end

#safeguard_policyString

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.

Returns:

  • (String)


4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4242

class MicrosoftSQLServerSettings < Struct.new(
  :port,
  :bcp_packet_size,
  :database_name,
  :control_tables_file_group,
  :password,
  :read_backup_only,
  :safeguard_policy,
  :server_name,
  :username,
  :use_bcp_full_load)
  SENSITIVE = [:password]
  include Aws::Structure
end

#server_nameString

Fully qualified domain name of the endpoint.

Returns:

  • (String)


4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4242

class MicrosoftSQLServerSettings < Struct.new(
  :port,
  :bcp_packet_size,
  :database_name,
  :control_tables_file_group,
  :password,
  :read_backup_only,
  :safeguard_policy,
  :server_name,
  :username,
  :use_bcp_full_load)
  SENSITIVE = [:password]
  include Aws::Structure
end

#use_bcp_full_loadBoolean

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)


4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4242

class MicrosoftSQLServerSettings < Struct.new(
  :port,
  :bcp_packet_size,
  :database_name,
  :control_tables_file_group,
  :password,
  :read_backup_only,
  :safeguard_policy,
  :server_name,
  :username,
  :use_bcp_full_load)
  SENSITIVE = [:password]
  include Aws::Structure
end

#usernameString

Endpoint connection user name.

Returns:

  • (String)


4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4242

class MicrosoftSQLServerSettings < Struct.new(
  :port,
  :bcp_packet_size,
  :database_name,
  :control_tables_file_group,
  :password,
  :read_backup_only,
  :safeguard_policy,
  :server_name,
  :username,
  :use_bcp_full_load)
  SENSITIVE = [:password]
  include Aws::Structure
end