IBMDb2Settings (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IBMDb2Settings
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides information that defines an IBM Db2 LUW endpoint.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

IBMDb2Settings()

Constructors
Constructor and Description
`IBMDb2Settings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IBMDb2Settings`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCurrentLsn()` For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
`String`	`getDatabaseName()` Database name for the endpoint.
`Integer`	`getMaxKBytesPerRead()` Maximum number of bytes per read, as a NUMBER value.
`String`	`getPassword()` Endpoint connection password.
`Integer`	`getPort()` Endpoint TCP port.
`String`	`getSecretsManagerAccessRoleArn()` 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`.
`String`	`getSecretsManagerSecretId()` The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the Db2 LUW endpoint connection details.
`String`	`getServerName()` Fully qualified domain name of the endpoint.
`Boolean`	`getSetDataCaptureChanges()` Enables ongoing replication (CDC) as a BOOLEAN value.
`String`	`getUsername()` Endpoint connection user name.
`int`	`hashCode()`
`Boolean`	`isSetDataCaptureChanges()` Enables ongoing replication (CDC) as a BOOLEAN value.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCurrentLsn(String currentLsn)` For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
`void`	`setDatabaseName(String databaseName)` Database name for the endpoint.
`void`	`setMaxKBytesPerRead(Integer maxKBytesPerRead)` Maximum number of bytes per read, as a NUMBER value.
`void`	`setPassword(String password)` Endpoint connection password.
`void`	`setPort(Integer port)` Endpoint TCP port.
`void`	`setSecretsManagerAccessRoleArn(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`.
`void`	`setSecretsManagerSecretId(String secretsManagerSecretId)` The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the Db2 LUW endpoint connection details.
`void`	`setServerName(String serverName)` Fully qualified domain name of the endpoint.
`void`	`setSetDataCaptureChanges(Boolean setDataCaptureChanges)` Enables ongoing replication (CDC) as a BOOLEAN value.
`void`	`setUsername(String username)` Endpoint connection user name.
`String`	`toString()` Returns a string representation of this object.
`IBMDb2Settings`	`withCurrentLsn(String currentLsn)` For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
`IBMDb2Settings`	`withDatabaseName(String databaseName)` Database name for the endpoint.
`IBMDb2Settings`	`withMaxKBytesPerRead(Integer maxKBytesPerRead)` Maximum number of bytes per read, as a NUMBER value.
`IBMDb2Settings`	`withPassword(String password)` Endpoint connection password.
`IBMDb2Settings`	`withPort(Integer port)` Endpoint TCP port.
`IBMDb2Settings`	`withSecretsManagerAccessRoleArn(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`.
`IBMDb2Settings`	`withSecretsManagerSecretId(String secretsManagerSecretId)` The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the Db2 LUW endpoint connection details.
`IBMDb2Settings`	`withServerName(String serverName)` Fully qualified domain name of the endpoint.
`IBMDb2Settings`	`withSetDataCaptureChanges(Boolean setDataCaptureChanges)` Enables ongoing replication (CDC) as a BOOLEAN value.
`IBMDb2Settings`	`withUsername(String username)` Endpoint connection user name.

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

- Constructor Detail
  - IBMDb2Settings
```
public IBMDb2Settings()
```
- Method Detail
  - 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 IBMDb2Settings 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.
  - 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 IBMDb2Settings 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.
  - 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 IBMDb2Settings 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.
  - setServerName
```
public void setServerName(String serverName)
```
    Fully qualified domain name of the endpoint.
    
    Parameters:
    
    serverName - Fully qualified domain name of the endpoint.
  - getServerName
```
public String getServerName()
```
    Fully qualified domain name of the endpoint.
    
    Returns:
    
    Fully qualified domain name of the endpoint.
  - withServerName
```
public IBMDb2Settings withServerName(String serverName)
```
    Fully qualified domain name of the endpoint.
    
    Parameters:
    
    serverName - Fully qualified domain name of the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSetDataCaptureChanges
```
public void setSetDataCaptureChanges(Boolean setDataCaptureChanges)
```
    Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
    
    Parameters:
    
    setDataCaptureChanges - Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
  - getSetDataCaptureChanges
```
public Boolean getSetDataCaptureChanges()
```
    Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
    
    Returns:
    
    Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
  - withSetDataCaptureChanges
```
public IBMDb2Settings withSetDataCaptureChanges(Boolean setDataCaptureChanges)
```
    Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
    
    Parameters:
    
    setDataCaptureChanges - Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isSetDataCaptureChanges
```
public Boolean isSetDataCaptureChanges()
```
    Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
    
    Returns:
    
    Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
  - setCurrentLsn
```
public void setCurrentLsn(String currentLsn)
```
    For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
    
    Parameters:
    
    currentLsn - For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
  - getCurrentLsn
```
public String getCurrentLsn()
```
    For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
    
    Returns:
    
    For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
  - withCurrentLsn
```
public IBMDb2Settings withCurrentLsn(String currentLsn)
```
    For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
    
    Parameters:
    
    currentLsn - For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxKBytesPerRead
```
public void setMaxKBytesPerRead(Integer maxKBytesPerRead)
```
    Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
    
    Parameters:
    
    maxKBytesPerRead - Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
  - getMaxKBytesPerRead
```
public Integer getMaxKBytesPerRead()
```
    Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
    
    Returns:
    
    Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
  - withMaxKBytesPerRead
```
public IBMDb2Settings withMaxKBytesPerRead(Integer maxKBytesPerRead)
```
    Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
    
    Parameters:
    
    maxKBytesPerRead - Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
    
    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 IBMDb2Settings 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.
  - setSecretsManagerAccessRoleArn
```
public void setSecretsManagerAccessRoleArn(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 Db2 LUW 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.
    
    Parameters:
    
    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 Db2 LUW 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.
  - getSecretsManagerAccessRoleArn
```
public String getSecretsManagerAccessRoleArn()
```
    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 Db2 LUW 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.
    
    Returns:
    
    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 Db2 LUW 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.
  - withSecretsManagerAccessRoleArn
```
public IBMDb2Settings withSecretsManagerAccessRoleArn(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 Db2 LUW 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.
    
    Parameters:
    
    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 Db2 LUW 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.
    
    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 Db2 LUW endpoint connection details.
    
    Parameters:
    
    secretsManagerSecretId - The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Db2 LUW endpoint connection details.
  - getSecretsManagerSecretId
```
public String getSecretsManagerSecretId()
```
    The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Db2 LUW endpoint connection details.
    
    Returns:
    
    The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Db2 LUW endpoint connection details.
  - withSecretsManagerSecretId
```
public IBMDb2Settings withSecretsManagerSecretId(String secretsManagerSecretId)
```
    The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Db2 LUW endpoint connection details.
    
    Parameters:
    
    secretsManagerSecretId - The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Db2 LUW endpoint connection details.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 IBMDb2Settings 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.

Did this page help you?

Class IBMDb2Settings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IBMDb2Settings

Method Detail

setDatabaseName

getDatabaseName

withDatabaseName

setPassword

getPassword

withPassword

setPort

getPort

withPort

setServerName

getServerName

withServerName

setSetDataCaptureChanges

getSetDataCaptureChanges

withSetDataCaptureChanges

isSetDataCaptureChanges

setCurrentLsn

getCurrentLsn

withCurrentLsn

setMaxKBytesPerRead

getMaxKBytesPerRead

withMaxKBytesPerRead

setUsername

getUsername

withUsername

setSecretsManagerAccessRoleArn

getSecretsManagerAccessRoleArn

withSecretsManagerAccessRoleArn

setSecretsManagerSecretId

getSecretsManagerSecretId

withSecretsManagerSecretId

toString

equals

hashCode

clone

marshall