Struct IbmDb2Settings

#[non_exhaustive]
pub struct IbmDb2Settings {

    pub database_name: Option<String>,
    pub password: Option<String>,
    pub port: Option<i32>,
    pub server_name: Option<String>,
    pub set_data_capture_changes: Option<bool>,
    pub current_lsn: Option<String>,
    pub max_k_bytes_per_read: Option<i32>,
    pub username: Option<String>,
    pub secrets_manager_access_role_arn: Option<String>,
    pub secrets_manager_secret_id: Option<String>,
    pub load_timeout: Option<i32>,
    pub write_buffer_size: Option<i32>,
    pub max_file_size: Option<i32>,
    pub keep_csv_files: Option<bool>,
}

Provides information that defines an IBM Db2 LUW endpoint.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

database_name: Option<String>

Database name for the endpoint.

password: Option<String>

Endpoint connection password.

port: Option<i32>

Endpoint TCP port. The default value is 50000.

server_name: Option<String>

Fully qualified domain name of the endpoint.

set_data_capture_changes: Option<bool>

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

current_lsn: Option<String>

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

max_k_bytes_per_read: Option<i32>

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

username: Option<String>

Endpoint connection user name.

secrets_manager_access_role_arn: Option<String>

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.

secrets_manager_secret_id: Option<String>

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

load_timeout: Option<i32>

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

write_buffer_size: Option<i32>

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

max_file_size: Option<i32>

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

keep_csv_files: Option<bool>

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.

Implementations

impl IbmDb2Settings

pub fn database_name(&self) -> Option<&str>

Database name for the endpoint.

pub fn password(&self) -> Option<&str>

Endpoint connection password.

pub fn port(&self) -> Option<i32>

Endpoint TCP port. The default value is 50000.

pub fn server_name(&self) -> Option<&str>

Fully qualified domain name of the endpoint.

pub fn set_data_capture_changes(&self) -> Option<bool>

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

pub fn current_lsn(&self) -> Option<&str>

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

pub fn max_k_bytes_per_read(&self) -> Option<i32>

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

pub fn username(&self) -> Option<&str>

Endpoint connection user name.

pub fn secrets_manager_access_role_arn(&self) -> Option<&str>

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.

pub fn secrets_manager_secret_id(&self) -> Option<&str>

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

pub fn load_timeout(&self) -> Option<i32>

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

pub fn write_buffer_size(&self) -> Option<i32>

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

pub fn max_file_size(&self) -> Option<i32>

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

pub fn keep_csv_files(&self) -> Option<bool>

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.

impl IbmDb2Settings

pub fn builder() -> IbmDb2SettingsBuilder

Creates a new builder-style object to manufacture IbmDb2Settings.

Trait Implementations

impl Clone for IbmDb2Settings

fn clone(&self) -> IbmDb2Settings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IbmDb2Settings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for IbmDb2Settings

fn eq(&self, other: &IbmDb2Settings) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for IbmDb2Settings