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 Summary

Modifier and Type	Method and Description
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.
IBMDb2Settings.Builder	databaseName(String databaseName) Database name for the endpoint.
IBMDb2Settings.Builder	maxKBytesPerRead(Integer maxKBytesPerRead) Maximum number of bytes per read, as a NUMBER value.
IBMDb2Settings.Builder	password(String password) Endpoint connection password.
IBMDb2Settings.Builder	port(Integer port) Endpoint TCP port.
IBMDb2Settings.Builder	secretsManagerAccessRoleArn(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.Builder	secretsManagerSecretId(String secretsManagerSecretId) The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Db2 LUW endpoint connection details.
IBMDb2Settings.Builder	serverName(String serverName) Fully qualified domain name of the endpoint.
IBMDb2Settings.Builder	setDataCaptureChanges(Boolean setDataCaptureChanges) Enables ongoing replication (CDC) as a BOOLEAN value.
IBMDb2Settings.Builder	username(String username) Endpoint connection user name.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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.

Parameters:

port - Endpoint TCP port.

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

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.