Package software.amazon.awssdk.services.databasemigration.model

Interface IBMDb2Settings.Builder

All Superinterfaces:
Buildable, CopyableBuilder<IBMDb2Settings.Builder,IBMDb2Settings>, SdkBuilder<IBMDb2Settings.Builder,IBMDb2Settings>, SdkPojo
Enclosing class:
IBMDb2Settings
public static interface IBMDb2Settings.Builder extends SdkPojo, CopyableBuilder<IBMDb2Settings.Builder,IBMDb2Settings>

  • Method Details

    • databaseName

      IBMDb2Settings.Builder databaseName(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.

    • password

      IBMDb2Settings.Builder password(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.

    • port

      IBMDb2Settings.Builder port(Integer port)

      Endpoint TCP port. The default value is 50000.

      Parameters:
      port - Endpoint TCP port. The default value is 50000.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverName

      IBMDb2Settings.Builder serverName(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.

    • setDataCaptureChanges

      IBMDb2Settings.Builder setDataCaptureChanges(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.

    • currentLsn

      IBMDb2Settings.Builder currentLsn(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.

    • maxKBytesPerRead

      IBMDb2Settings.Builder maxKBytesPerRead(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.

    • username

      IBMDb2Settings.Builder username(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.

    • secretsManagerAccessRoleArn

      IBMDb2Settings.Builder 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 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.

      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 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secretsManagerSecretId

      IBMDb2Settings.Builder secretsManagerSecretId(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.

    • loadTimeout

      IBMDb2Settings.Builder loadTimeout(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).

      Parameters:
      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).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • writeBufferSize

      IBMDb2Settings.Builder writeBufferSize(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).

      Parameters:
      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).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxFileSize

      IBMDb2Settings.Builder maxFileSize(Integer maxFileSize)

      Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.

      Parameters:
      maxFileSize - Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • keepCsvFiles

      IBMDb2Settings.Builder keepCsvFiles(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.