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

Class IBMDb2Settings

java.lang.Object
software.amazon.awssdk.services.databasemigration.model.IBMDb2Settings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<IBMDb2Settings.Builder,IBMDb2Settings>
@Generated("software.amazon.awssdk:codegen") public final class IBMDb2Settings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IBMDb2Settings.Builder,IBMDb2Settings>

Provides information that defines an IBM Db2 LUW endpoint.

See Also:

  • Method Details

    • databaseName

      public final String databaseName()

      Database name for the endpoint.

      Returns:
      Database name for the endpoint.

    • password

      public final String password()

      Endpoint connection password.

      Returns:
      Endpoint connection password.

    • port

      public final Integer port()

      Endpoint TCP port. The default value is 50000.

      Returns:
      Endpoint TCP port. The default value is 50000.

    • serverName

      public final String serverName()

      Fully qualified domain name of the endpoint.

      Returns:
      Fully qualified domain name of the endpoint.

    • setDataCaptureChanges

      public final Boolean setDataCaptureChanges()

      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.

    • currentLsn

      public final String currentLsn()

      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.

    • maxKBytesPerRead

      public final Integer maxKBytesPerRead()

      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.

    • username

      public final String username()

      Endpoint connection user name.

      Returns:
      Endpoint connection user name.

    • secretsManagerAccessRoleArn

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

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

    • secretsManagerSecretId

      public final String secretsManagerSecretId()

      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.

    • loadTimeout

      public final 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).

      Returns:
      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).

    • writeBufferSize

      public final 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).

      Returns:
      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).

    • maxFileSize

      public final Integer maxFileSize()

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

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

    • keepCsvFiles

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

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

    • toBuilder

      public IBMDb2Settings.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<IBMDb2Settings.Builder,IBMDb2Settings>
      Returns:
      a builder for type T

    • builder

      public static IBMDb2Settings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends IBMDb2Settings.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.