MicrosoftSQLServerSettings (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.databasemigrationservice.model.MicrosoftSQLServerSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MicrosoftSQLServerSettings
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides information that defines a Microsoft SQL Server endpoint.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MicrosoftSQLServerSettings()

Constructors
Constructor and Description
`MicrosoftSQLServerSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MicrosoftSQLServerSettings`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getBcpPacketSize()` The maximum size of the packets (in bytes) used to transfer data using BCP.
`String`	`getControlTablesFileGroup()` Specifies a file group for the DMS internal tables.
`String`	`getDatabaseName()` Database name for the endpoint.
`Boolean`	`getForceLobLookup()` Forces LOB lookup on inline LOB.
`String`	`getPassword()` Endpoint connection password.
`Integer`	`getPort()` Endpoint TCP port.
`Boolean`	`getQuerySingleAlwaysOnNode()` Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
`Boolean`	`getReadBackupOnly()` 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.
`String`	`getSafeguardPolicy()` 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.
`String`	`getSecretsManagerAccessRoleArn()` 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`.
`String`	`getSecretsManagerSecretId()` The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the SQL Server endpoint connection details.
`String`	`getServerName()` Fully qualified domain name of the endpoint.
`String`	`getTlogAccessMode()` Indicates the mode used to fetch CDC data.
`Boolean`	`getTrimSpaceInChar()` Use the `TrimSpaceInChar` source endpoint setting to right-trim data on CHAR and NCHAR data types during migration.
`Boolean`	`getUseBcpFullLoad()` Use this to attribute to transfer data for full-load operations using BCP.
`String`	`getUsername()` Endpoint connection user name.
`Boolean`	`getUseThirdPartyBackupDevice()` When this attribute is set to `Y`, DMS processes third-party transaction log backups if they are created in native format.
`int`	`hashCode()`
`Boolean`	`isForceLobLookup()` Forces LOB lookup on inline LOB.
`Boolean`	`isQuerySingleAlwaysOnNode()` Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
`Boolean`	`isReadBackupOnly()` 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.
`Boolean`	`isTrimSpaceInChar()` Use the `TrimSpaceInChar` source endpoint setting to right-trim data on CHAR and NCHAR data types during migration.
`Boolean`	`isUseBcpFullLoad()` Use this to attribute to transfer data for full-load operations using BCP.
`Boolean`	`isUseThirdPartyBackupDevice()` When this attribute is set to `Y`, DMS processes third-party transaction log backups if they are created in native format.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBcpPacketSize(Integer bcpPacketSize)` The maximum size of the packets (in bytes) used to transfer data using BCP.
`void`	`setControlTablesFileGroup(String controlTablesFileGroup)` Specifies a file group for the DMS internal tables.
`void`	`setDatabaseName(String databaseName)` Database name for the endpoint.
`void`	`setForceLobLookup(Boolean forceLobLookup)` Forces LOB lookup on inline LOB.
`void`	`setPassword(String password)` Endpoint connection password.
`void`	`setPort(Integer port)` Endpoint TCP port.
`void`	`setQuerySingleAlwaysOnNode(Boolean querySingleAlwaysOnNode)` Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
`void`	`setReadBackupOnly(Boolean 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.
`void`	`setSafeguardPolicy(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.
`void`	`setSecretsManagerAccessRoleArn(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 in `SecretsManagerSecret`.
`void`	`setSecretsManagerSecretId(String secretsManagerSecretId)` The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the SQL Server endpoint connection details.
`void`	`setServerName(String serverName)` Fully qualified domain name of the endpoint.
`void`	`setTlogAccessMode(String tlogAccessMode)` Indicates the mode used to fetch CDC data.
`void`	`setTrimSpaceInChar(Boolean trimSpaceInChar)` Use the `TrimSpaceInChar` source endpoint setting to right-trim data on CHAR and NCHAR data types during migration.
`void`	`setUseBcpFullLoad(Boolean useBcpFullLoad)` Use this to attribute to transfer data for full-load operations using BCP.
`void`	`setUsername(String username)` Endpoint connection user name.
`void`	`setUseThirdPartyBackupDevice(Boolean useThirdPartyBackupDevice)` When this attribute is set to `Y`, DMS processes third-party transaction log backups if they are created in native format.
`String`	`toString()` Returns a string representation of this object.
`MicrosoftSQLServerSettings`	`withBcpPacketSize(Integer bcpPacketSize)` The maximum size of the packets (in bytes) used to transfer data using BCP.
`MicrosoftSQLServerSettings`	`withControlTablesFileGroup(String controlTablesFileGroup)` Specifies a file group for the DMS internal tables.
`MicrosoftSQLServerSettings`	`withDatabaseName(String databaseName)` Database name for the endpoint.
`MicrosoftSQLServerSettings`	`withForceLobLookup(Boolean forceLobLookup)` Forces LOB lookup on inline LOB.
`MicrosoftSQLServerSettings`	`withPassword(String password)` Endpoint connection password.
`MicrosoftSQLServerSettings`	`withPort(Integer port)` Endpoint TCP port.
`MicrosoftSQLServerSettings`	`withQuerySingleAlwaysOnNode(Boolean querySingleAlwaysOnNode)` Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
`MicrosoftSQLServerSettings`	`withReadBackupOnly(Boolean 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.
`MicrosoftSQLServerSettings`	`withSafeguardPolicy(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.
`MicrosoftSQLServerSettings`	`withSafeguardPolicy(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.
`MicrosoftSQLServerSettings`	`withSecretsManagerAccessRoleArn(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 in `SecretsManagerSecret`.
`MicrosoftSQLServerSettings`	`withSecretsManagerSecretId(String secretsManagerSecretId)` The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the SQL Server endpoint connection details.
`MicrosoftSQLServerSettings`	`withServerName(String serverName)` Fully qualified domain name of the endpoint.
`MicrosoftSQLServerSettings`	`withTlogAccessMode(String tlogAccessMode)` Indicates the mode used to fetch CDC data.
`MicrosoftSQLServerSettings`	`withTlogAccessMode(TlogAccessMode tlogAccessMode)` Indicates the mode used to fetch CDC data.
`MicrosoftSQLServerSettings`	`withTrimSpaceInChar(Boolean trimSpaceInChar)` Use the `TrimSpaceInChar` source endpoint setting to right-trim data on CHAR and NCHAR data types during migration.
`MicrosoftSQLServerSettings`	`withUseBcpFullLoad(Boolean useBcpFullLoad)` Use this to attribute to transfer data for full-load operations using BCP.
`MicrosoftSQLServerSettings`	`withUsername(String username)` Endpoint connection user name.
`MicrosoftSQLServerSettings`	`withUseThirdPartyBackupDevice(Boolean useThirdPartyBackupDevice)` When this attribute is set to `Y`, DMS processes third-party transaction log backups if they are created in native format.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MicrosoftSQLServerSettings
```
public MicrosoftSQLServerSettings()
```
- Method Detail
  - setPort
```
public void setPort(Integer port)
```
    Endpoint TCP port.
    
    Parameters:
    
    port - Endpoint TCP port.
  - getPort
```
public Integer getPort()
```
    Endpoint TCP port.
    
    Returns:
    
    Endpoint TCP port.
  - withPort
```
public MicrosoftSQLServerSettings withPort(Integer port)
```
    Endpoint TCP port.
    
    Parameters:
    
    port - Endpoint TCP port.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBcpPacketSize
```
public void setBcpPacketSize(Integer 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.
  - getBcpPacketSize
```
public Integer getBcpPacketSize()
```
    The maximum size of the packets (in bytes) used to transfer data using BCP.
    
    Returns:
    
    The maximum size of the packets (in bytes) used to transfer data using BCP.
  - withBcpPacketSize
```
public MicrosoftSQLServerSettings withBcpPacketSize(Integer 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.
  - setDatabaseName
```
public void setDatabaseName(String databaseName)
```
    Database name for the endpoint.
    
    Parameters:
    
    databaseName - Database name for the endpoint.
  - getDatabaseName
```
public String getDatabaseName()
```
    Database name for the endpoint.
    
    Returns:
    
    Database name for the endpoint.
  - withDatabaseName
```
public MicrosoftSQLServerSettings withDatabaseName(String 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.
  - setControlTablesFileGroup
```
public void setControlTablesFileGroup(String 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.
  - getControlTablesFileGroup
```
public String getControlTablesFileGroup()
```
    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:
    
    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.
  - withControlTablesFileGroup
```
public MicrosoftSQLServerSettings withControlTablesFileGroup(String 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.
  - setPassword
```
public void setPassword(String password)
```
    Endpoint connection password.
    
    Parameters:
    
    password - Endpoint connection password.
  - getPassword
```
public String getPassword()
```
    Endpoint connection password.
    
    Returns:
    
    Endpoint connection password.
  - withPassword
```
public MicrosoftSQLServerSettings withPassword(String password)
```
    Endpoint connection password.
    
    Parameters:
    
    password - Endpoint connection password.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQuerySingleAlwaysOnNode
```
public void setQuerySingleAlwaysOnNode(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.
    
    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.
  - getQuerySingleAlwaysOnNode
```
public Boolean getQuerySingleAlwaysOnNode()
```
    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:
    
    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.
  - withQuerySingleAlwaysOnNode
```
public MicrosoftSQLServerSettings withQuerySingleAlwaysOnNode(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.
    
    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.
  - isQuerySingleAlwaysOnNode
```
public Boolean isQuerySingleAlwaysOnNode()
```
    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:
    
    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.
  - setReadBackupOnly
```
public void setReadBackupOnly(Boolean 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 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.
    
    Parameters:
    
    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 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.
  - getReadBackupOnly
```
public Boolean getReadBackupOnly()
```
    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.
    
    Returns:
    
    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.
  - withReadBackupOnly
```
public MicrosoftSQLServerSettings withReadBackupOnly(Boolean 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 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.
    
    Parameters:
    
    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 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isReadBackupOnly
```
public Boolean isReadBackupOnly()
```
    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.
    
    Returns:
    
    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.
  - setSafeguardPolicy
```
public void setSafeguardPolicy(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.
    
    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.
    
    See Also:
    
    SafeguardPolicy
  - getSafeguardPolicy
```
public String getSafeguardPolicy()
```
    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:
    
    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.
    
    See Also:
    
    SafeguardPolicy
  - withSafeguardPolicy
```
public MicrosoftSQLServerSettings withSafeguardPolicy(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.
    
    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
  - withSafeguardPolicy
```
public MicrosoftSQLServerSettings withSafeguardPolicy(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.
    
    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
  - setServerName
```
public void setServerName(String 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 the Endpoint.Address field.
  - getServerName
```
public String getServerName()
```
    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.
    
    Returns:
    
    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.
  - withServerName
```
public MicrosoftSQLServerSettings withServerName(String 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 the Endpoint.Address field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUsername
```
public void setUsername(String username)
```
    Endpoint connection user name.
    
    Parameters:
    
    username - Endpoint connection user name.
  - getUsername
```
public String getUsername()
```
    Endpoint connection user name.
    
    Returns:
    
    Endpoint connection user name.
  - withUsername
```
public MicrosoftSQLServerSettings withUsername(String 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.
  - setUseBcpFullLoad
```
public void setUseBcpFullLoad(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.
    
    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.
  - getUseBcpFullLoad
```
public Boolean getUseBcpFullLoad()
```
    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:
    
    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.
  - withUseBcpFullLoad
```
public MicrosoftSQLServerSettings withUseBcpFullLoad(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.
    
    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.
  - isUseBcpFullLoad
```
public Boolean isUseBcpFullLoad()
```
    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:
    
    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.
  - setUseThirdPartyBackupDevice
```
public void setUseThirdPartyBackupDevice(Boolean 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 to Y, DMS processes third-party transaction log backups if they are created in native format.
  - getUseThirdPartyBackupDevice
```
public Boolean getUseThirdPartyBackupDevice()
```
    When this attribute is set to Y, DMS processes third-party transaction log backups if they are created in native format.
    
    Returns:
    
    When this attribute is set to Y, DMS processes third-party transaction log backups if they are created in native format.
  - withUseThirdPartyBackupDevice
```
public MicrosoftSQLServerSettings withUseThirdPartyBackupDevice(Boolean 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 to Y, 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.
  - isUseThirdPartyBackupDevice
```
public Boolean isUseThirdPartyBackupDevice()
```
    When this attribute is set to Y, DMS processes third-party transaction log backups if they are created in native format.
    
    Returns:
    
    When this attribute is set to Y, DMS processes third-party transaction log backups if they are created in native format.
  - setSecretsManagerAccessRoleArn
```
public void setSecretsManagerAccessRoleArn(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 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.
    
    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 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 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.
    
    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 Database Migration Service resources in the Database Migration Service User Guide.
  - getSecretsManagerAccessRoleArn
```
public String getSecretsManagerAccessRoleArn()
```
    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.
    
    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 Database Migration Service resources in the Database Migration Service User Guide.
    
    Returns:
    
    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.
    
    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 Database Migration Service resources in the Database Migration Service User Guide.
  - withSecretsManagerAccessRoleArn
```
public MicrosoftSQLServerSettings withSecretsManagerAccessRoleArn(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 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.
    
    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 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 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.
    
    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 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.
  - setSecretsManagerSecretId
```
public void setSecretsManagerSecretId(String 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 the SecretsManagerSecret that contains the SQL Server endpoint connection details.
  - getSecretsManagerSecretId
```
public String getSecretsManagerSecretId()
```
    The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SQL Server endpoint connection details.
    
    Returns:
    
    The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SQL Server endpoint connection details.
  - withSecretsManagerSecretId
```
public MicrosoftSQLServerSettings withSecretsManagerSecretId(String 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 the SecretsManagerSecret that contains the SQL Server endpoint connection details.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrimSpaceInChar
```
public void setTrimSpaceInChar(Boolean trimSpaceInChar)
```
    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.
    
    Parameters:
    
    trimSpaceInChar - 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.
  - getTrimSpaceInChar
```
public Boolean getTrimSpaceInChar()
```
    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.
    
    Returns:
    
    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.
  - withTrimSpaceInChar
```
public MicrosoftSQLServerSettings withTrimSpaceInChar(Boolean trimSpaceInChar)
```
    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.
    
    Parameters:
    
    trimSpaceInChar - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isTrimSpaceInChar
```
public Boolean isTrimSpaceInChar()
```
    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.
    
    Returns:
    
    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.
  - setTlogAccessMode
```
public void setTlogAccessMode(String tlogAccessMode)
```
    Indicates the mode used to fetch CDC data.
    
    Parameters:
    
    tlogAccessMode - Indicates the mode used to fetch CDC data.
    
    See Also:
    
    TlogAccessMode
  - getTlogAccessMode
```
public String getTlogAccessMode()
```
    Indicates the mode used to fetch CDC data.
    
    Returns:
    
    Indicates the mode used to fetch CDC data.
    
    See Also:
    
    TlogAccessMode
  - withTlogAccessMode
```
public MicrosoftSQLServerSettings withTlogAccessMode(String 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
  - withTlogAccessMode
```
public MicrosoftSQLServerSettings withTlogAccessMode(TlogAccessMode 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
  - setForceLobLookup
```
public void setForceLobLookup(Boolean forceLobLookup)
```
    Forces LOB lookup on inline LOB.
    
    Parameters:
    
    forceLobLookup - Forces LOB lookup on inline LOB.
  - getForceLobLookup
```
public Boolean getForceLobLookup()
```
    Forces LOB lookup on inline LOB.
    
    Returns:
    
    Forces LOB lookup on inline LOB.
  - withForceLobLookup
```
public MicrosoftSQLServerSettings withForceLobLookup(Boolean 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.
  - isForceLobLookup
```
public Boolean isForceLobLookup()
```
    Forces LOB lookup on inline LOB.
    
    Returns:
    
    Forces LOB lookup on inline LOB.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public MicrosoftSQLServerSettings clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class MicrosoftSQLServerSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MicrosoftSQLServerSettings

Method Detail

setPort

getPort

withPort

setBcpPacketSize

getBcpPacketSize

withBcpPacketSize

setDatabaseName

getDatabaseName

withDatabaseName

setControlTablesFileGroup

getControlTablesFileGroup

withControlTablesFileGroup

setPassword

getPassword

withPassword

setQuerySingleAlwaysOnNode

getQuerySingleAlwaysOnNode

withQuerySingleAlwaysOnNode

isQuerySingleAlwaysOnNode

setReadBackupOnly

getReadBackupOnly

withReadBackupOnly

isReadBackupOnly

setSafeguardPolicy

getSafeguardPolicy

withSafeguardPolicy

withSafeguardPolicy

setServerName

getServerName

withServerName

setUsername

getUsername

withUsername

setUseBcpFullLoad

getUseBcpFullLoad

withUseBcpFullLoad

isUseBcpFullLoad

setUseThirdPartyBackupDevice

getUseThirdPartyBackupDevice

withUseThirdPartyBackupDevice

isUseThirdPartyBackupDevice

setSecretsManagerAccessRoleArn

getSecretsManagerAccessRoleArn

withSecretsManagerAccessRoleArn

setSecretsManagerSecretId

getSecretsManagerSecretId

withSecretsManagerSecretId

setTrimSpaceInChar

getTrimSpaceInChar

withTrimSpaceInChar

isTrimSpaceInChar

setTlogAccessMode

getTlogAccessMode

withTlogAccessMode

withTlogAccessMode

setForceLobLookup

getForceLobLookup

withForceLobLookup

isForceLobLookup

toString

equals

hashCode

clone

marshall