databasemigrationservice/aws.sdk.kotlin.services.databasemigrationservice.model/MicrosoftSqlServerSettings/Builder

Builder

Properties

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

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.

databaseName

var databaseName: String?

Database name for the endpoint.

forceLobLookup

var forceLobLookup: Boolean?

Forces LOB lookup on inline LOB.

password

var password: String?

Endpoint connection password.

port

var port: Int?

Endpoint TCP port.

querySingleAlwaysOnNode

var querySingleAlwaysOnNode: 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.

readBackupOnly

var readBackupOnly: 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.

safeguardPolicy

var safeguardPolicy: SafeguardPolicy?

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.

secretsManagerAccessRoleArn

var secretsManagerAccessRoleArn: 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.

secretsManagerSecretId

var secretsManagerSecretId: String?

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

serverName

var serverName: String?

Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the output of DescribeDBInstances, in the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html">Endpoint</a>.Address field.

tlogAccessMode

var tlogAccessMode: TlogAccessMode?

Indicates the mode used to fetch CDC data.

trimSpaceInChar

var trimSpaceInChar: 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.

useBcpFullLoad

var useBcpFullLoad: 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.

username

var username: String?

Endpoint connection user name.

useThirdPartyBackupDevice

var useThirdPartyBackupDevice: Boolean?

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