Struct aws_sdk_databasemigration::types::builders::MicrosoftSqlServerSettingsBuilder

#[non_exhaustive]
pub struct MicrosoftSqlServerSettingsBuilder { /* private fields */ }

A builder for MicrosoftSqlServerSettings.

Implementations

impl MicrosoftSqlServerSettingsBuilder

pub fn port(self, input: i32) -> Self

Endpoint TCP port.

pub fn set_port(self, input: Option<i32>) -> Self

Endpoint TCP port.

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

Endpoint TCP port.

pub fn bcp_packet_size(self, input: i32) -> Self

The maximum size of the packets (in bytes) used to transfer data using BCP.

pub fn set_bcp_packet_size(self, input: Option<i32>) -> Self

The maximum size of the packets (in bytes) used to transfer data using BCP.

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

The maximum size of the packets (in bytes) used to transfer data using BCP.

pub fn database_name(self, input: impl Into<String>) -> Self

Database name for the endpoint.

pub fn set_database_name(self, input: Option<String>) -> Self

Database name for the endpoint.

pub fn get_database_name(&self) -> &Option<String>

Database name for the endpoint.

pub fn control_tables_file_group(self, input: impl Into<String>) -> Self

Specifies a file group for the DMS internal tables. When the replication task starts, all the internal DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group.

pub fn set_control_tables_file_group(self, input: Option<String>) -> Self

Specifies a file group for the DMS internal tables. When the replication task starts, all the internal DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group.

pub fn get_control_tables_file_group(&self) -> &Option<String>

Specifies a file group for the DMS internal tables. When the replication task starts, all the internal DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group.

pub fn password(self, input: impl Into<String>) -> Self

Endpoint connection password.

pub fn set_password(self, input: Option<String>) -> Self

Endpoint connection password.

pub fn get_password(&self) -> &Option<String>

Endpoint connection password.

pub fn query_single_always_on_node(self, input: bool) -> Self

Cleans and recreates table metadata information on the replication instance when a mismatch occurs. An example is a situation where running an alter DDL statement on a table might result in different information about the table cached in the replication instance.

pub fn set_query_single_always_on_node(self, input: Option<bool>) -> Self

Cleans and recreates table metadata information on the replication instance when a mismatch occurs. An example is a situation where running an alter DDL statement on a table might result in different information about the table cached in the replication instance.

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

Cleans and recreates table metadata information on the replication instance when a mismatch occurs. An example is a situation where running an alter DDL statement on a table might result in different information about the table cached in the replication instance.

pub fn read_backup_only(self, input: bool) -> Self

When this attribute is set to Y, DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication. Setting this parameter to Y enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication.

pub fn set_read_backup_only(self, input: Option<bool>) -> Self

When this attribute is set to Y, DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication. Setting this parameter to Y enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication.

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

When this attribute is set to Y, DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication. Setting this parameter to Y enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication.

pub fn safeguard_policy(self, input: SafeguardPolicy) -> Self

Use this attribute to minimize the need to access the backup log and enable DMS to prevent truncation using one of the following two methods.

Start transactions in the database: This is the default method. When this method is used, DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.

Exclusively use sp_repldone within a single task: When this method is used, DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one DMS task can access the database at any given time. Therefore, if you need to run parallel DMS tasks against the same database, use the default method.

pub fn set_safeguard_policy(self, input: Option<SafeguardPolicy>) -> Self

Use this attribute to minimize the need to access the backup log and enable DMS to prevent truncation using one of the following two methods.

Start transactions in the database: This is the default method. When this method is used, DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.

Exclusively use sp_repldone within a single task: When this method is used, DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one DMS task can access the database at any given time. Therefore, if you need to run parallel DMS tasks against the same database, use the default method.

pub fn get_safeguard_policy(&self) -> &Option<SafeguardPolicy>

Use this attribute to minimize the need to access the backup log and enable DMS to prevent truncation using one of the following two methods.

Start transactions in the database: This is the default method. When this method is used, DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.

Exclusively use sp_repldone within a single task: When this method is used, DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one DMS task can access the database at any given time. Therefore, if you need to run parallel DMS tasks against the same database, use the default method.

pub fn server_name(self, input: impl Into<String>) -> Self

Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.

pub fn set_server_name(self, input: Option<String>) -> Self

Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.

pub fn get_server_name(&self) -> &Option<String>

Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.

pub fn username(self, input: impl Into<String>) -> Self

Endpoint connection user name.

pub fn set_username(self, input: Option<String>) -> Self

Endpoint connection user name.

pub fn get_username(&self) -> &Option<String>

Endpoint connection user name.

pub fn use_bcp_full_load(self, input: bool) -> Self

Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.

pub fn set_use_bcp_full_load(self, input: Option<bool>) -> Self

Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.

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

Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.

pub fn use_third_party_backup_device(self, input: bool) -> Self

When this attribute is set to Y, DMS processes third-party transaction log backups if they are created in native format.

pub fn set_use_third_party_backup_device(self, input: Option<bool>) -> Self

When this attribute is set to Y, DMS processes third-party transaction log backups if they are created in native format.

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

When this attribute is set to Y, DMS processes third-party transaction log backups if they are created in native format.

pub fn secrets_manager_access_role_arn(self, input: impl Into<String>) -> Self

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 SQL Server 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 set_secrets_manager_access_role_arn(self, input: Option<String>) -> Self

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 SQL Server 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 get_secrets_manager_access_role_arn(&self) -> &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 SQL Server 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, input: impl Into<String>) -> Self

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

pub fn set_secrets_manager_secret_id(self, input: Option<String>) -> Self

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

pub fn get_secrets_manager_secret_id(&self) -> &Option<String>

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

pub fn trim_space_in_char(self, input: bool) -> Self

Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is true.

pub fn set_trim_space_in_char(self, input: Option<bool>) -> Self

Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is true.

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

Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is true.

pub fn tlog_access_mode(self, input: TlogAccessMode) -> Self

Indicates the mode used to fetch CDC data.

pub fn set_tlog_access_mode(self, input: Option<TlogAccessMode>) -> Self

Indicates the mode used to fetch CDC data.

pub fn get_tlog_access_mode(&self) -> &Option<TlogAccessMode>

Indicates the mode used to fetch CDC data.

pub fn force_lob_lookup(self, input: bool) -> Self

Forces LOB lookup on inline LOB.

pub fn set_force_lob_lookup(self, input: Option<bool>) -> Self

Forces LOB lookup on inline LOB.

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

Forces LOB lookup on inline LOB.

pub fn build(self) -> MicrosoftSqlServerSettings

Consumes the builder and constructs a MicrosoftSqlServerSettings.

Trait Implementations

impl Clone for MicrosoftSqlServerSettingsBuilder

fn clone(&self) -> MicrosoftSqlServerSettingsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MicrosoftSqlServerSettingsBuilder

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

Formats the value using the given formatter.

impl Default for MicrosoftSqlServerSettingsBuilder

fn default() -> MicrosoftSqlServerSettingsBuilder

Returns the “default value” for a type.

impl PartialEq<MicrosoftSqlServerSettingsBuilder> for MicrosoftSqlServerSettingsBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for MicrosoftSqlServerSettingsBuilder