@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.
Constructor and Description |
---|
IBMDb2Settings() |
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.
|
Boolean |
getKeepCsvFiles()
If true, DMS saves any .csv files to the Db2 LUW target that were used to replicate data.
|
Integer |
getLoadTimeout()
The amount of time (in milliseconds) before DMS times out operations performed by DMS on the Db2 target.
|
Integer |
getMaxFileSize()
Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.
|
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 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.
|
Integer |
getWriteBufferSize()
The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk on the DMS
replication instance.
|
int |
hashCode() |
Boolean |
isKeepCsvFiles()
If true, DMS saves any .csv files to the Db2 LUW target that were used to replicate data.
|
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 |
setKeepCsvFiles(Boolean keepCsvFiles)
If true, DMS saves any .csv files to the Db2 LUW target that were used to replicate data.
|
void |
setLoadTimeout(Integer loadTimeout)
The amount of time (in milliseconds) before DMS times out operations performed by DMS on the Db2 target.
|
void |
setMaxFileSize(Integer maxFileSize)
Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.
|
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 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.
|
void |
setWriteBufferSize(Integer writeBufferSize)
The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk on the DMS
replication instance.
|
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 |
withKeepCsvFiles(Boolean keepCsvFiles)
If true, DMS saves any .csv files to the Db2 LUW target that were used to replicate data.
|
IBMDb2Settings |
withLoadTimeout(Integer loadTimeout)
The amount of time (in milliseconds) before DMS times out operations performed by DMS on the Db2 target.
|
IBMDb2Settings |
withMaxFileSize(Integer maxFileSize)
Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.
|
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 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.
|
IBMDb2Settings |
withWriteBufferSize(Integer writeBufferSize)
The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk on the DMS
replication instance.
|
public void setDatabaseName(String databaseName)
Database name for the endpoint.
databaseName
- Database name for the endpoint.public String getDatabaseName()
Database name for the endpoint.
public IBMDb2Settings withDatabaseName(String databaseName)
Database name for the endpoint.
databaseName
- Database name for the endpoint.public void setPassword(String password)
Endpoint connection password.
password
- Endpoint connection password.public String getPassword()
Endpoint connection password.
public IBMDb2Settings withPassword(String password)
Endpoint connection password.
password
- Endpoint connection password.public void setPort(Integer port)
Endpoint TCP port. The default value is 50000.
port
- Endpoint TCP port. The default value is 50000.public Integer getPort()
Endpoint TCP port. The default value is 50000.
public IBMDb2Settings withPort(Integer port)
Endpoint TCP port. The default value is 50000.
port
- Endpoint TCP port. The default value is 50000.public void setServerName(String serverName)
Fully qualified domain name of the endpoint.
serverName
- Fully qualified domain name of the endpoint.public String getServerName()
Fully qualified domain name of the endpoint.
public IBMDb2Settings withServerName(String serverName)
Fully qualified domain name of the endpoint.
serverName
- Fully qualified domain name of the endpoint.public void setSetDataCaptureChanges(Boolean setDataCaptureChanges)
Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
setDataCaptureChanges
- Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.public Boolean getSetDataCaptureChanges()
Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
public IBMDb2Settings withSetDataCaptureChanges(Boolean setDataCaptureChanges)
Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
setDataCaptureChanges
- Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.public Boolean isSetDataCaptureChanges()
Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
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.
currentLsn
- For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the
replication to start.public String getCurrentLsn()
For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
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.
currentLsn
- For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the
replication to start.public void setMaxKBytesPerRead(Integer maxKBytesPerRead)
Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
maxKBytesPerRead
- Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.public Integer getMaxKBytesPerRead()
Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
public IBMDb2Settings withMaxKBytesPerRead(Integer maxKBytesPerRead)
Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
maxKBytesPerRead
- Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.public void setUsername(String username)
Endpoint connection user name.
username
- Endpoint connection user name.public String getUsername()
Endpoint connection user name.
public IBMDb2Settings withUsername(String username)
Endpoint connection user name.
username
- Endpoint connection user name.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 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 Database Migration Service resources in the Database Migration Service User Guide.
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 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 Database Migration Service resources in the Database Migration Service
User Guide.
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 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 Database Migration Service resources in the Database Migration Service User Guide.
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 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 Database Migration Service resources in the Database Migration Service
User Guide.
public IBMDb2Settings 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 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 Database Migration Service resources in the Database Migration Service User Guide.
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 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 Database Migration Service resources in the Database Migration Service
User Guide.
public void setSecretsManagerSecretId(String secretsManagerSecretId)
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the Db2 LUW
endpoint connection details.
secretsManagerSecretId
- The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the Db2
LUW endpoint connection details.public String getSecretsManagerSecretId()
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the Db2 LUW
endpoint connection details.
SecretsManagerSecret
that contains the
Db2 LUW endpoint connection details.public IBMDb2Settings withSecretsManagerSecretId(String secretsManagerSecretId)
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the Db2 LUW
endpoint connection details.
secretsManagerSecretId
- The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the Db2
LUW endpoint connection details.public void setLoadTimeout(Integer loadTimeout)
The amount of time (in milliseconds) before DMS times out operations performed by DMS on the Db2 target. The default value is 1200 (20 minutes).
loadTimeout
- The amount of time (in milliseconds) before DMS times out operations performed by DMS on the Db2 target.
The default value is 1200 (20 minutes).public Integer getLoadTimeout()
The amount of time (in milliseconds) before DMS times out operations performed by DMS on the Db2 target. The default value is 1200 (20 minutes).
public IBMDb2Settings withLoadTimeout(Integer loadTimeout)
The amount of time (in milliseconds) before DMS times out operations performed by DMS on the Db2 target. The default value is 1200 (20 minutes).
loadTimeout
- The amount of time (in milliseconds) before DMS times out operations performed by DMS on the Db2 target.
The default value is 1200 (20 minutes).public void setWriteBufferSize(Integer writeBufferSize)
The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk on the DMS replication instance. The default value is 1024 (1 MB).
writeBufferSize
- The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk on
the DMS replication instance. The default value is 1024 (1 MB).public Integer getWriteBufferSize()
The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk on the DMS replication instance. The default value is 1024 (1 MB).
public IBMDb2Settings withWriteBufferSize(Integer writeBufferSize)
The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk on the DMS replication instance. The default value is 1024 (1 MB).
writeBufferSize
- The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk on
the DMS replication instance. The default value is 1024 (1 MB).public void setMaxFileSize(Integer maxFileSize)
Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.
maxFileSize
- Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.public Integer getMaxFileSize()
Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.
public IBMDb2Settings withMaxFileSize(Integer maxFileSize)
Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.
maxFileSize
- Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.public void setKeepCsvFiles(Boolean keepCsvFiles)
If true, DMS saves any .csv files to the Db2 LUW target that were used to replicate data. DMS uses these files for analysis and troubleshooting.
The default value is false.
keepCsvFiles
- If true, DMS saves any .csv files to the Db2 LUW target that were used to replicate data. DMS uses these
files for analysis and troubleshooting.
The default value is false.
public Boolean getKeepCsvFiles()
If true, DMS saves any .csv files to the Db2 LUW target that were used to replicate data. DMS uses these files for analysis and troubleshooting.
The default value is false.
The default value is false.
public IBMDb2Settings withKeepCsvFiles(Boolean keepCsvFiles)
If true, DMS saves any .csv files to the Db2 LUW target that were used to replicate data. DMS uses these files for analysis and troubleshooting.
The default value is false.
keepCsvFiles
- If true, DMS saves any .csv files to the Db2 LUW target that were used to replicate data. DMS uses these
files for analysis and troubleshooting.
The default value is false.
public Boolean isKeepCsvFiles()
If true, DMS saves any .csv files to the Db2 LUW target that were used to replicate data. DMS uses these files for analysis and troubleshooting.
The default value is false.
The default value is false.
public String toString()
toString
in class Object
Object.toString()
public IBMDb2Settings clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.