Struct MicrosoftSqlServerSettings

#[non_exhaustive]
pub struct MicrosoftSqlServerSettings {

    pub port: Option<i32>,
    pub bcp_packet_size: Option<i32>,
    pub database_name: Option<String>,
    pub control_tables_file_group: Option<String>,
    pub password: Option<String>,
    pub query_single_always_on_node: Option<bool>,
    pub read_backup_only: Option<bool>,
    pub safeguard_policy: Option<SafeguardPolicy>,
    pub server_name: Option<String>,
    pub username: Option<String>,
    pub use_bcp_full_load: Option<bool>,
    pub use_third_party_backup_device: Option<bool>,
    pub secrets_manager_access_role_arn: Option<String>,
    pub secrets_manager_secret_id: Option<String>,
    pub trim_space_in_char: Option<bool>,
    pub tlog_access_mode: Option<TlogAccessMode>,
    pub force_lob_lookup: Option<bool>,
    pub authentication_method: Option<SqlServerAuthenticationMethod>,
}

Provides information that defines a Microsoft SQL Server 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.

port: Option<i32>

Endpoint TCP port.

bcp_packet_size: Option<i32>

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

database_name: Option<String>

Database name for the endpoint.

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

password: Option<String>

Endpoint connection password.

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

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

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

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

username: Option<String>

Endpoint connection user name.

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

use_third_party_backup_device: Option<bool>

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

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

secrets_manager_secret_id: Option<String>

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

trim_space_in_char: Option<bool>

Use the TrimSpaceInChar source endpoint setting to right-trim data on CHAR and NCHAR data types during migration. Setting TrimSpaceInChar does not left-trim data. The default value is true.

tlog_access_mode: Option<TlogAccessMode>

Indicates the mode used to fetch CDC data.

force_lob_lookup: Option<bool>

Forces LOB lookup on inline LOB.

authentication_method: Option<SqlServerAuthenticationMethod>

Specifies using Kerberos authentication with Microsoft SQL Server.

Implementations

impl MicrosoftSqlServerSettings

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

Endpoint TCP port.

pub fn 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) -> Option<&str>

Database name for the endpoint.

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

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) -> Option<&str>

Endpoint connection password.

pub fn 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) -> 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) -> 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) -> Option<&str>

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) -> Option<&str>

Endpoint connection user name.

pub fn 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) -> 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) -> 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 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) -> Option<&str>

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) -> Option<bool>

Use the TrimSpaceInChar source endpoint setting to right-trim data on CHAR and NCHAR data types during migration. Setting TrimSpaceInChar does not left-trim data. The default value is true.

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

Indicates the mode used to fetch CDC data.

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

Forces LOB lookup on inline LOB.

pub fn authentication_method(&self) -> Option<&SqlServerAuthenticationMethod>

Specifies using Kerberos authentication with Microsoft SQL Server.

impl MicrosoftSqlServerSettings

pub fn builder() -> MicrosoftSqlServerSettingsBuilder

Creates a new builder-style object to manufacture MicrosoftSqlServerSettings.

Trait Implementations

impl Clone for MicrosoftSqlServerSettings

fn clone(&self) -> MicrosoftSqlServerSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MicrosoftSqlServerSettings

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

Formats the value using the given formatter.

impl PartialEq for MicrosoftSqlServerSettings

fn eq(&self, other: &MicrosoftSqlServerSettings) -> 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 MicrosoftSqlServerSettings