Class CfnEndpoint.MicrosoftSqlServerSettingsProperty

Provides information that defines a Microsoft SQL Server endpoint.

Inheritance

object

CfnEndpoint.MicrosoftSqlServerSettingsProperty

Implements

CfnEndpoint.IMicrosoftSqlServerSettingsProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.DMS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnEndpoint.MicrosoftSqlServerSettingsProperty : CfnEndpoint.IMicrosoftSqlServerSettingsProperty

Syntax (vb)

Public Class CfnEndpoint.MicrosoftSqlServerSettingsProperty Implements CfnEndpoint.IMicrosoftSqlServerSettingsProperty

Remarks

This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For information about other available settings, see Extra connection attributes when using SQL Server as a source for AWS DMS and Extra connection attributes when using SQL Server as a target for AWS DMS in the AWS Database Migration Service User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.DMS;

             var microsoftSqlServerSettingsProperty = new MicrosoftSqlServerSettingsProperty {
                 BcpPacketSize = 123,
                 ControlTablesFileGroup = "controlTablesFileGroup",
                 DatabaseName = "databaseName",
                 ForceLobLookup = false,
                 Password = "password",
                 Port = 123,
                 QuerySingleAlwaysOnNode = false,
                 ReadBackupOnly = false,
                 SafeguardPolicy = "safeguardPolicy",
                 SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
                 SecretsManagerSecretId = "secretsManagerSecretId",
                 ServerName = "serverName",
                 TlogAccessMode = "tlogAccessMode",
                 TrimSpaceInChar = false,
                 UseBcpFullLoad = false,
                 Username = "username",
                 UseThirdPartyBackupDevice = false
             };

Synopsis

Constructors

MicrosoftSqlServerSettingsProperty()

Provides information that defines a Microsoft SQL Server endpoint.

Properties

BcpPacketSize	The maximum size of the packets (in bytes) used to transfer data using BCP.
ControlTablesFileGroup	Specifies a file group for the AWS DMS internal tables.
DatabaseName	Database name for the endpoint.
ForceLobLookup	Forces LOB lookup on inline LOB.
Password	Endpoint connection password.
Port	Endpoint TCP port.
QuerySingleAlwaysOnNode	Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
ReadBackupOnly	When this attribute is set to Y , AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication.
SafeguardPolicy	Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
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 .
SecretsManagerSecretId	The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MicrosoftSQLServer endpoint connection details.
ServerName	Fully qualified domain name of the endpoint.
TlogAccessMode	Indicates the mode used to fetch CDC data.
TrimSpaceInChar	Use the TrimSpaceInChar source endpoint setting to right-trim data on CHAR and NCHAR data types during migration.
UseBcpFullLoad	Use this to attribute to transfer data for full-load operations using BCP.
UseThirdPartyBackupDevice	When this attribute is set to Y , DMS processes third-party transaction log backups if they are created in native format.
Username	Endpoint connection user name.

Constructors

MicrosoftSqlServerSettingsProperty()

Provides information that defines a Microsoft SQL Server endpoint.

public MicrosoftSqlServerSettingsProperty()

Remarks

This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For information about other available settings, see Extra connection attributes when using SQL Server as a source for AWS DMS and Extra connection attributes when using SQL Server as a target for AWS DMS in the AWS Database Migration Service User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.DMS;

             var microsoftSqlServerSettingsProperty = new MicrosoftSqlServerSettingsProperty {
                 BcpPacketSize = 123,
                 ControlTablesFileGroup = "controlTablesFileGroup",
                 DatabaseName = "databaseName",
                 ForceLobLookup = false,
                 Password = "password",
                 Port = 123,
                 QuerySingleAlwaysOnNode = false,
                 ReadBackupOnly = false,
                 SafeguardPolicy = "safeguardPolicy",
                 SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
                 SecretsManagerSecretId = "secretsManagerSecretId",
                 ServerName = "serverName",
                 TlogAccessMode = "tlogAccessMode",
                 TrimSpaceInChar = false,
                 UseBcpFullLoad = false,
                 Username = "username",
                 UseThirdPartyBackupDevice = false
             };

Properties

BcpPacketSize

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

public double? BcpPacketSize { get; set; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-bcppacketsize

ControlTablesFileGroup

Specifies a file group for the AWS DMS internal tables.

public string? ControlTablesFileGroup { get; set; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-controltablesfilegroup

DatabaseName

Database name for the endpoint.

public string? DatabaseName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-databasename

ForceLobLookup

Forces LOB lookup on inline LOB.

public object? ForceLobLookup { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-forceloblookup

Password

Endpoint connection password.

public string? Password { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-password

Port

Endpoint TCP port.

public double? Port { get; set; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-port

QuerySingleAlwaysOnNode

Cleans and recreates table metadata information on the replication instance when a mismatch occurs.

public object? QuerySingleAlwaysOnNode { get; set; }

Property Value

object

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-querysinglealwaysonnode

ReadBackupOnly

When this attribute is set to Y , AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication.

public object? ReadBackupOnly { get; set; }

Property Value

object

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-readbackuponly

SafeguardPolicy

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

public string? SafeguardPolicy { get; set; }

Property Value

string

Remarks

Start transactions in the database: This is the default method. When this method is used, AWS 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, AWS 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 AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-safeguardpolicy

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 .

public string? SecretsManagerAccessRoleArn { get; set; }

Property Value

string

Remarks

The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the AWS 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 <code>SecretsManagerSecretId</code> . Or you can specify clear-text values for <code>UserName</code> , <code>Password</code> , <code>ServerName</code> , and <code>Port</code> . You can't specify both.

For more information on creating this SecretsManagerSecret , the corresponding SecretsManagerAccessRoleArn , and the SecretsManagerSecretId that is required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-secretsmanageraccessrolearn

SecretsManagerSecretId

The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MicrosoftSQLServer endpoint connection details.

public string? SecretsManagerSecretId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-secretsmanagersecretid

ServerName

Fully qualified domain name of the endpoint.

public string? ServerName { get; set; }

Property Value

string

Remarks

For an Amazon RDS SQL Server instance, this is the output of DescribeDBInstances , in the Endpoint .Address field.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-servername

TlogAccessMode

Indicates the mode used to fetch CDC data.

public string? TlogAccessMode { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-tlogaccessmode

TrimSpaceInChar

Use the TrimSpaceInChar source endpoint setting to right-trim data on CHAR and NCHAR data types during migration.

public object? TrimSpaceInChar { get; set; }

Property Value

object

Remarks

Setting TrimSpaceInChar does not left-trim data. The default value is true .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-trimspaceinchar

UseBcpFullLoad

Use this to attribute to transfer data for full-load operations using BCP.

public object? UseBcpFullLoad { get; set; }

Property Value

object

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-usebcpfullload

UseThirdPartyBackupDevice

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

public object? UseThirdPartyBackupDevice { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-usethirdpartybackupdevice

Username

Endpoint connection user name.

public string? Username { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-username

Implements

CfnEndpoint.IMicrosoftSqlServerSettingsProperty