Interface MicrosoftSQLServerSettings.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<MicrosoftSQLServerSettings.Builder,
,MicrosoftSQLServerSettings> SdkBuilder<MicrosoftSQLServerSettings.Builder,
,MicrosoftSQLServerSettings> SdkPojo
- Enclosing class:
MicrosoftSQLServerSettings
-
Method Summary
Modifier and TypeMethodDescriptionbcpPacketSize
(Integer bcpPacketSize) The maximum size of the packets (in bytes) used to transfer data using BCP.controlTablesFileGroup
(String controlTablesFileGroup) Specifies a file group for the DMS internal tables.databaseName
(String databaseName) Database name for the endpoint.forceLobLookup
(Boolean forceLobLookup) Forces LOB lookup on inline LOB.Endpoint connection password.Endpoint TCP port.querySingleAlwaysOnNode
(Boolean querySingleAlwaysOnNode) Cleans and recreates table metadata information on the replication instance when a mismatch occurs.readBackupOnly
(Boolean readBackupOnly) When this attribute is set toY
, DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication.safeguardPolicy
(String 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.safeguardPolicy
(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
(String secretsManagerAccessRoleArn) 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 inSecretsManagerSecret
.secretsManagerSecretId
(String secretsManagerSecretId) The full ARN, partial ARN, or friendly name of theSecretsManagerSecret
that contains the SQL Server endpoint connection details.serverName
(String serverName) Fully qualified domain name of the endpoint.tlogAccessMode
(String tlogAccessMode) Indicates the mode used to fetch CDC data.tlogAccessMode
(TlogAccessMode tlogAccessMode) Indicates the mode used to fetch CDC data.trimSpaceInChar
(Boolean trimSpaceInChar) Use theTrimSpaceInChar
source endpoint setting to right-trim data on CHAR and NCHAR data types during migration.useBcpFullLoad
(Boolean useBcpFullLoad) Use this to attribute to transfer data for full-load operations using BCP.Endpoint connection user name.useThirdPartyBackupDevice
(Boolean useThirdPartyBackupDevice) When this attribute is set toY
, DMS processes third-party transaction log backups if they are created in native format.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
port
Endpoint TCP port.
- Parameters:
port
- Endpoint TCP port.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bcpPacketSize
The maximum size of the packets (in bytes) used to transfer data using BCP.
- Parameters:
bcpPacketSize
- The maximum size of the packets (in bytes) used to transfer data using BCP.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
databaseName
Database name for the endpoint.
- Parameters:
databaseName
- Database name for the endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
controlTablesFileGroup
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.
- Parameters:
controlTablesFileGroup
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
password
Endpoint connection password.
- Parameters:
password
- Endpoint connection password.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
readBackupOnly
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 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.- Parameters:
readBackupOnly
- When this attribute is set toY
, 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
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.
- Parameters:
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.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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
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.
- Parameters:
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.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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
serverName
- Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the output of DescribeDBInstances, in theEndpoint.Address
field.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
username
Endpoint connection user name.
- Parameters:
username
- Endpoint connection user name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
useThirdPartyBackupDevice
When this attribute is set to
Y
, DMS processes third-party transaction log backups if they are created in native format.- Parameters:
useThirdPartyBackupDevice
- When this attribute is set toY
, DMS processes third-party transaction log backups if they are created in native format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
secretsManagerAccessRoleArn
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 theiam:PassRole
action.SecretsManagerSecret
has the value of the Amazon Web Services 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 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 Database Migration Service resources in the Database Migration Service User Guide.- Parameters:
secretsManagerAccessRoleArn
- 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 inSecretsManagerSecret
. The role must allow theiam:PassRole
action.SecretsManagerSecret
has the value of the Amazon Web Services 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 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 Database Migration Service resources in the Database Migration Service User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
secretsManagerSecretId
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret
that contains the SQL Server endpoint connection details.- Parameters:
secretsManagerSecretId
- The full ARN, partial ARN, or friendly name of theSecretsManagerSecret
that contains the SQL Server endpoint connection details.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
.- Parameters:
trimSpaceInChar
- Use theTrimSpaceInChar
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
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tlogAccessMode
Indicates the mode used to fetch CDC data.
- Parameters:
tlogAccessMode
- Indicates the mode used to fetch CDC data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tlogAccessMode
Indicates the mode used to fetch CDC data.
- Parameters:
tlogAccessMode
- Indicates the mode used to fetch CDC data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
forceLobLookup
Forces LOB lookup on inline LOB.
- Parameters:
forceLobLookup
- Forces LOB lookup on inline LOB.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-