IBMDb2Settings - AWS Database Migration Service

IBMDb2Settings

Provides information that defines an IBM Db2 LUW endpoint.

Contents

CurrentLsn

For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.

Type: String

Required: No

DatabaseName

Database name for the endpoint.

Type: String

Required: No

KeepCsvFiles

If true, AWS 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.

Type: Boolean

Required: No

LoadTimeout

The amount of time (in milliseconds) before AWS DMS times out operations performed by DMS on the Db2 target. The default value is 1200 (20 minutes).

Type: Integer

Required: No

MaxFileSize

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

Type: Integer

Required: No

MaxKBytesPerRead

Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.

Type: Integer

Required: No

Password

Endpoint connection password.

Type: String

Required: No

Port

Endpoint TCP port. The default value is 50000.

Type: Integer

Required: No

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. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.

Note

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.

Type: String

Required: No

SecretsManagerSecretId

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Db2 LUW endpoint connection details.

Type: String

Required: No

ServerName

Fully qualified domain name of the endpoint.

Type: String

Required: No

SetDataCaptureChanges

Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.

Type: Boolean

Required: No

Username

Endpoint connection user name.

Type: String

Required: No

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

Type: Integer

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: