public static interface MicrosoftSQLServerSettings.Builder extends SdkPojo, CopyableBuilder<MicrosoftSQLServerSettings.Builder,MicrosoftSQLServerSettings>
| Modifier and Type | Method and Description |
|---|---|
MicrosoftSQLServerSettings.Builder |
bcpPacketSize(Integer bcpPacketSize)
The maximum size of the packets (in bytes) used to transfer data using BCP.
|
MicrosoftSQLServerSettings.Builder |
controlTablesFileGroup(String controlTablesFileGroup)
Specifies a file group for the AWS DMS internal tables.
|
MicrosoftSQLServerSettings.Builder |
databaseName(String databaseName)
Database name for the endpoint.
|
MicrosoftSQLServerSettings.Builder |
password(String password)
Endpoint connection password.
|
MicrosoftSQLServerSettings.Builder |
port(Integer port)
Endpoint TCP port.
|
MicrosoftSQLServerSettings.Builder |
querySingleAlwaysOnNode(Boolean querySingleAlwaysOnNode)
Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
|
MicrosoftSQLServerSettings.Builder |
readBackupOnly(Boolean 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. |
MicrosoftSQLServerSettings.Builder |
safeguardPolicy(SafeguardPolicy 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.
|
MicrosoftSQLServerSettings.Builder |
safeguardPolicy(String 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.
|
MicrosoftSQLServerSettings.Builder |
secretsManagerAccessRoleArn(String 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. |
MicrosoftSQLServerSettings.Builder |
secretsManagerSecretId(String secretsManagerSecretId)
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret that contains the SQL
Server endpoint connection details. |
MicrosoftSQLServerSettings.Builder |
serverName(String serverName)
Fully qualified domain name of the endpoint.
|
MicrosoftSQLServerSettings.Builder |
useBcpFullLoad(Boolean useBcpFullLoad)
Use this to attribute to transfer data for full-load operations using BCP.
|
MicrosoftSQLServerSettings.Builder |
username(String username)
Endpoint connection user name.
|
MicrosoftSQLServerSettings.Builder |
useThirdPartyBackupDevice(Boolean useThirdPartyBackupDevice)
When this attribute is set to
Y, DMS processes third-party transaction log backups if they are
created in native format. |
equalsBySdkFields, sdkFieldscopyapplyMutation, buildMicrosoftSQLServerSettings.Builder port(Integer port)
Endpoint TCP port.
port - Endpoint TCP port.MicrosoftSQLServerSettings.Builder bcpPacketSize(Integer bcpPacketSize)
The maximum size of the packets (in bytes) used to transfer data using BCP.
bcpPacketSize - The maximum size of the packets (in bytes) used to transfer data using BCP.MicrosoftSQLServerSettings.Builder databaseName(String databaseName)
Database name for the endpoint.
databaseName - Database name for the endpoint.MicrosoftSQLServerSettings.Builder controlTablesFileGroup(String 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.
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.MicrosoftSQLServerSettings.Builder password(String password)
Endpoint connection password.
password - Endpoint connection password.MicrosoftSQLServerSettings.Builder querySingleAlwaysOnNode(Boolean 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.
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.MicrosoftSQLServerSettings.Builder readBackupOnly(Boolean 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 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.
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 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.MicrosoftSQLServerSettings.Builder safeguardPolicy(String 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.
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.
SafeguardPolicy,
SafeguardPolicyMicrosoftSQLServerSettings.Builder safeguardPolicy(SafeguardPolicy 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.
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.
SafeguardPolicy,
SafeguardPolicyMicrosoftSQLServerSettings.Builder serverName(String serverName)
Fully qualified domain name of the endpoint.
serverName - Fully qualified domain name of the endpoint.MicrosoftSQLServerSettings.Builder username(String username)
Endpoint connection user name.
username - Endpoint connection user name.MicrosoftSQLServerSettings.Builder useBcpFullLoad(Boolean 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.
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.MicrosoftSQLServerSettings.Builder useThirdPartyBackupDevice(Boolean useThirdPartyBackupDevice)
When this attribute is set to Y, DMS processes third-party transaction log backups if they are
created in native format.
useThirdPartyBackupDevice - When this attribute is set to Y, DMS processes third-party transaction log backups if
they are created in native format.MicrosoftSQLServerSettings.Builder secretsManagerAccessRoleArn(String 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.
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 and the
SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see
Using secrets to access AWS Database Migration Service resources in the AWS Database Migration
Service User Guide.
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.
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 and the
SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access
it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration
Service User Guide.
MicrosoftSQLServerSettings.Builder secretsManagerSecretId(String secretsManagerSecretId)
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SQL
Server endpoint connection details.
secretsManagerSecretId - The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the
SQL Server endpoint connection details.Copyright © 2021. All rights reserved.