interface MicrosoftSqlServerSettingsProperty

Language	Type name
.NET	`Amazon.CDK.AWS.DMS.CfnEndpoint.MicrosoftSqlServerSettingsProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsdms#CfnEndpoint_MicrosoftSqlServerSettingsProperty`
Java	`software.amazon.awscdk.services.dms.CfnEndpoint.MicrosoftSqlServerSettingsProperty`
Python	`aws_cdk.aws_dms.CfnEndpoint.MicrosoftSqlServerSettingsProperty`
TypeScript	`aws-cdk-lib` » `aws_dms` » `CfnEndpoint` » `MicrosoftSqlServerSettingsProperty`

Provides information that defines a Microsoft SQL Server 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 SQL Server as a source for AWS DMS and Extra connection attributes when using SQL Server as a target for AWS DMS in the AWS Database Migration Service User Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dms as dms } from 'aws-cdk-lib';
const microsoftSqlServerSettingsProperty: dms.CfnEndpoint.MicrosoftSqlServerSettingsProperty = {
  bcpPacketSize: 123,
  controlTablesFileGroup: 'controlTablesFileGroup',
  databaseName: 'databaseName',
  forceLobLookup: false,
  password: 'password',
  port: 123,
  querySingleAlwaysOnNode: false,
  readBackupOnly: false,
  safeguardPolicy: 'safeguardPolicy',
  secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
  secretsManagerSecretId: 'secretsManagerSecretId',
  serverName: 'serverName',
  tlogAccessMode: 'tlogAccessMode',
  trimSpaceInChar: false,
  useBcpFullLoad: false,
  username: 'username',
  useThirdPartyBackupDevice: false,
};

Properties

Name	Type	Description
bcpPacketSize?	`number`	The maximum size of the packets (in bytes) used to transfer data using BCP.
controlTablesFileGroup?	`string`	Specifies a file group for the AWS DMS internal tables.
databaseName?	`string`	Database name for the endpoint.
forceLobLookup?	`boolean \|` `IResolvable`	Forces LOB lookup on inline LOB.
password?	`string`	Endpoint connection password.
port?	`number`	Endpoint TCP port.
querySingleAlwaysOnNode?	`boolean \|` `IResolvable`	Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
readBackupOnly?	`boolean \|` `IResolvable`	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.
safeguardPolicy?	`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.
secretsManagerAccessRoleArn?	`string`	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` .
secretsManagerSecretId?	`string`	The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MicrosoftSQLServer endpoint connection details.
serverName?	`string`	Fully qualified domain name of the endpoint.
tlogAccessMode?	`string`	Indicates the mode used to fetch CDC data.
trimSpaceInChar?	`boolean \|` `IResolvable`	Use the `TrimSpaceInChar` source endpoint setting to right-trim data on CHAR and NCHAR data types during migration.
useBcpFullLoad?	`boolean \|` `IResolvable`	Use this to attribute to transfer data for full-load operations using BCP.
useThirdPartyBackupDevice?	`boolean \|` `IResolvable`	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.

bcpPacketSize?

Type: number (optional)

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

controlTablesFileGroup?

Type: string (optional)

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.

databaseName?

Type: string (optional)

Database name for the endpoint.

forceLobLookup?

Type: boolean | IResolvable (optional)

Forces LOB lookup on inline LOB.

password?

Type: string (optional)

Endpoint connection password.

port?

Type: number (optional)

Endpoint TCP port.

querySingleAlwaysOnNode?

Type: boolean | IResolvable (optional)

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.

readBackupOnly?

Type: boolean | IResolvable (optional)

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.

safeguardPolicy?

Type: string (optional)

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.

secretsManagerAccessRoleArn?

Type: string (optional)

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

secretsManagerSecretId?

Type: string (optional)

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

serverName?

Type: string (optional)

Fully qualified domain name of the endpoint.

For an Amazon RDS SQL Server instance, this is the output of DescribeDBInstances , in the [Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) .Address field.

tlogAccessMode?

Type: string (optional)

Indicates the mode used to fetch CDC data.

trimSpaceInChar?

Type: boolean | IResolvable (optional)

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 .

useBcpFullLoad?

Type: boolean | IResolvable (optional)

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.

useThirdPartyBackupDevice?

Type: boolean | IResolvable (optional)

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

username?

Type: string (optional)

Endpoint connection user name.