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

Inherits:

Struct

• Object
• Struct
• Aws::DatabaseMigrationService::Types::MicrosoftSQLServerSettings

Includes:

Structure

Defined in:

lib/aws-sdk-databasemigrationservice/types.rb

Overview

Provides information that defines a Microsoft SQL Server endpoint.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:password]

Instance Attribute Summary

• #bcp_packet_size ⇒ Integer

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

• #control_tables_file_group ⇒ String

  Specifies a file group for the DMS internal tables.

• #database_name ⇒ String

  Database name for the endpoint.

• #force_lob_lookup ⇒ Boolean

  Forces LOB lookup on inline LOB.

• #password ⇒ String

  Endpoint connection password.

• #port ⇒ Integer

  Endpoint TCP port.

• #query_single_always_on_node ⇒ Boolean

  Cleans and recreates table metadata information on the replication instance when a mismatch occurs.

• #read_backup_only ⇒ Boolean

  When this attribute is set to ‘Y`, 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 DMS to prevent truncation using one of the following two methods.

• #secrets_manager_access_role_arn ⇒ String

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

• #secrets_manager_secret_id ⇒ String

  The full ARN, partial ARN, or friendly name of the ‘SecretsManagerSecret` that contains the SQL Server endpoint connection details.

• #server_name ⇒ String

  Fully qualified domain name of the endpoint.

• #tlog_access_mode ⇒ String

  Indicates the mode used to fetch CDC data.

• #trim_space_in_char ⇒ Boolean

  Use the ‘TrimSpaceInChar` source endpoint setting to right-trim data on CHAR and NCHAR data types during migration.

• #use_bcp_full_load ⇒ Boolean

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

• #use_third_party_backup_device ⇒ Boolean

  When this attribute is set to ‘Y`, DMS processes third-party transaction log backups if they are created in native format.

• #username ⇒ String

  Endpoint connection user name.

Instance Attribute Details

#bcp_packet_size ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6774

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

#control_tables_file_group ⇒ String

Specifies a file group for the DMS internal tables. When the replication task starts, all the internal DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group.

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6774

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

#database_name ⇒ String

Database name for the endpoint.

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6774

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

#force_lob_lookup ⇒ Boolean

Forces LOB lookup on inline LOB.

Returns:

• (Boolean)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6774

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

#password ⇒ String

Endpoint connection password.

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6774

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

#port ⇒ Integer

Endpoint TCP port.

Returns:

• (Integer)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6774

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

#query_single_always_on_node ⇒ Boolean

Cleans and recreates table metadata information on the replication instance when a mismatch occurs. An example is a situation where running an alter DDL statement on a table might result in different information about the table cached in the replication instance.

Returns:

• (Boolean)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6774

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

#read_backup_only ⇒ Boolean

When this attribute is set to ‘Y`, 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)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6774

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

#safeguard_policy ⇒ String

Use this attribute to minimize the need to access the backup log and enable 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, 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, 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 DMS task can access the database at any given time. Therefore, if you need to run parallel DMS tasks against the same database, use the default method.

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6774

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

#secrets_manager_access_role_arn ⇒ String

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 SQL Server endpoint.

<note markdown=“1”> 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*.

</note>

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6774

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

#secrets_manager_secret_id ⇒ String

The full ARN, partial ARN, or friendly name of the ‘SecretsManagerSecret` that contains the SQL Server endpoint connection details.

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6774

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

#server_name ⇒ String

Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the output of [DescribeDBInstances], in the ‘ Endpoint.Address` field.

[1]: docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6774

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

#tlog_access_mode ⇒ String

Indicates the mode used to fetch CDC data.

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6774

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

#trim_space_in_char ⇒ Boolean

Use the ‘TrimSpaceInChar` source endpoint setting to right-trim data on CHAR and NCHAR data types during migration. Setting `TrimSpaceInChar` does not left-trim data. The default value is `true`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6774

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

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

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6774

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

#use_third_party_backup_device ⇒ Boolean

When this attribute is set to ‘Y`, DMS processes third-party transaction log backups if they are created in native format.

Returns:

• (Boolean)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6774

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

#username ⇒ String

Endpoint connection user name.

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6774

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