pub struct Builder { /* private fields */ }
Expand description
A builder for MicrosoftSqlServerSettings
.
Implementations§
source§impl Builder
impl Builder
sourcepub fn bcp_packet_size(self, input: i32) -> Self
pub fn bcp_packet_size(self, input: i32) -> Self
The maximum size of the packets (in bytes) used to transfer data using BCP.
sourcepub fn set_bcp_packet_size(self, input: Option<i32>) -> Self
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.
sourcepub fn database_name(self, input: impl Into<String>) -> Self
pub fn database_name(self, input: impl Into<String>) -> Self
Database name for the endpoint.
sourcepub fn set_database_name(self, input: Option<String>) -> Self
pub fn set_database_name(self, input: Option<String>) -> Self
Database name for the endpoint.
sourcepub fn control_tables_file_group(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_control_tables_file_group(self, input: Option<String>) -> Self
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.
sourcepub fn set_password(self, input: Option<String>) -> Self
pub fn set_password(self, input: Option<String>) -> Self
Endpoint connection password.
sourcepub fn query_single_always_on_node(self, input: bool) -> Self
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.
sourcepub fn set_query_single_always_on_node(self, input: Option<bool>) -> Self
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.
sourcepub fn read_backup_only(self, input: bool) -> Self
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.
sourcepub fn set_read_backup_only(self, input: Option<bool>) -> Self
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.
sourcepub fn safeguard_policy(self, input: SafeguardPolicy) -> Self
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.
sourcepub fn set_safeguard_policy(self, input: Option<SafeguardPolicy>) -> Self
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.
sourcepub fn server_name(self, input: impl Into<String>) -> Self
pub fn server_name(self, input: impl Into<String>) -> Self
Fully qualified domain name of the endpoint.
sourcepub fn set_server_name(self, input: Option<String>) -> Self
pub fn set_server_name(self, input: Option<String>) -> Self
Fully qualified domain name of the endpoint.
sourcepub fn set_username(self, input: Option<String>) -> Self
pub fn set_username(self, input: Option<String>) -> Self
Endpoint connection user name.
sourcepub fn use_bcp_full_load(self, input: bool) -> Self
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.
sourcepub fn set_use_bcp_full_load(self, input: Option<bool>) -> Self
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.
sourcepub fn use_third_party_backup_device(self, input: bool) -> Self
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.
sourcepub fn set_use_third_party_backup_device(self, input: Option<bool>) -> Self
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.
sourcepub fn secrets_manager_access_role_arn(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_secrets_manager_access_role_arn(self, input: Option<String>) -> Self
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.
sourcepub fn secrets_manager_secret_id(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_secrets_manager_secret_id(self, input: Option<String>) -> Self
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.
sourcepub fn trim_space_in_char(self, input: bool) -> Self
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
.
sourcepub fn set_trim_space_in_char(self, input: Option<bool>) -> Self
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
.
sourcepub fn build(self) -> MicrosoftSqlServerSettings
pub fn build(self) -> MicrosoftSqlServerSettings
Consumes the builder and constructs a MicrosoftSqlServerSettings
.