MicrosoftSQLServerSettings
Provides information that defines a Microsoft SQL Server endpoint.
Contents
- BcpPacketSize
-
The maximum size of the packets (in bytes) used to transfer data using BCP.
Type: Integer
Required: No
- ControlTablesFileGroup
-
Specifies a file group 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 for the specified file group.
Type: String
Required: No
- DatabaseName
-
Database name for the endpoint.
Type: String
Required: No
- ForceLobLookup
-
Forces LOB lookup on inline LOB.
Type: Boolean
Required: No
- Password
-
Endpoint connection password.
Type: String
Required: No
- Port
-
Endpoint TCP port.
Type: Integer
Required: No
- QuerySingleAlwaysOnNode
-
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.
Type: Boolean
Required: No
- ReadBackupOnly
-
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 toY
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.Type: Boolean
Required: No
- SafeguardPolicy
-
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.
Type: String
Valid Values:
rely-on-sql-server-replication-agent | exclusive-automatic-truncation | shared-automatic-truncation
Required: No
- SecretsManagerAccessRoleArn
-
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 theiam:PassRole
action.SecretsManagerSecret
has the value of the AWS Secrets Manager secret that allows access to the SQL Server endpoint.Note
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 forUserName
,Password
,ServerName
, andPort
. You can't specify both. For more information on creating thisSecretsManagerSecret
and theSecretsManagerAccessRoleArn
andSecretsManagerSecretId
required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide.Type: String
Required: No
- SecretsManagerSecretId
-
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret
that contains the SQL Server endpoint connection details.Type: String
Required: No
- ServerName
-
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.Type: String
Required: No
- TlogAccessMode
-
Indicates the mode used to fetch CDC data.
Type: String
Valid Values:
BackupOnly | PreferBackup | PreferTlog | TlogOnly
Required: No
- TrimSpaceInChar
-
Use the
TrimSpaceInChar
source endpoint setting to right-trim data on CHAR and NCHAR data types during migration. SettingTrimSpaceInChar
does not left-trim data. The default value istrue
.Type: Boolean
Required: No
- UseBcpFullLoad
-
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.
Type: Boolean
Required: No
- Username
-
Endpoint connection user name.
Type: String
Required: No
- UseThirdPartyBackupDevice
-
When this attribute is set to
Y
, DMS processes third-party transaction log backups if they are created in native format.Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: