Package software.amazon.awscdk.services.dms

Interface CfnEndpoint.MicrosoftSqlServerSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpoint.MicrosoftSqlServerSettingsProperty.Jsii$Proxy

Enclosing class:

CfnEndpoint

@Stability(Stable)
public static interface CfnEndpoint.MicrosoftSqlServerSettingsProperty
extends software.amazon.jsii.JsiiSerializable

Provides information that defines a Microsoft SQL Server endpoint.

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dms.*;
 MicrosoftSqlServerSettingsProperty microsoftSqlServerSettingsProperty = MicrosoftSqlServerSettingsProperty.builder()
         .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)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEndpoint.MicrosoftSqlServerSettingsProperty.Builder	A builder for CfnEndpoint.MicrosoftSqlServerSettingsProperty
static final class	CfnEndpoint.MicrosoftSqlServerSettingsProperty.Jsii$Proxy	An implementation for CfnEndpoint.MicrosoftSqlServerSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnEndpoint.MicrosoftSqlServerSettingsProperty.Builder	builder()
default Number	getBcpPacketSize()	The maximum size of the packets (in bytes) used to transfer data using BCP.
default String	getControlTablesFileGroup()	Specifies a file group for the AWS DMS internal tables.
default String	getDatabaseName()	Database name for the endpoint.
default Object	getForceLobLookup()	Forces LOB lookup on inline LOB.
default String	getPassword()	Endpoint connection password.
default Number	getPort()	Endpoint TCP port.
default Object	getQuerySingleAlwaysOnNode()	Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
default Object	getReadBackupOnly()	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.
default String	getSafeguardPolicy()	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.
default String	getSecretsManagerAccessRoleArn()	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 .
default String	getSecretsManagerSecretId()	The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MicrosoftSQLServer endpoint connection details.
default String	getServerName()	Fully qualified domain name of the endpoint.
default String	getTlogAccessMode()	Indicates the mode used to fetch CDC data.
default Object	getTrimSpaceInChar()	Use the TrimSpaceInChar source endpoint setting to right-trim data on CHAR and NCHAR data types during migration.
default Object	getUseBcpFullLoad()	Use this to attribute to transfer data for full-load operations using BCP.
default String	getUsername()	Endpoint connection user name.
default Object	getUseThirdPartyBackupDevice()	When this attribute is set to Y , DMS processes third-party transaction log backups if they are created in native format.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBcpPacketSize

@Stability(Stable)
@Nullable
default Number getBcpPacketSize()

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

See Also:

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

getControlTablesFileGroup

@Stability(Stable)
@Nullable
default String getControlTablesFileGroup()

Specifies a file group for the AWS DMS internal tables.

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 Also:

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

getDatabaseName

@Stability(Stable)
@Nullable
default String getDatabaseName()

Database name for the endpoint.

See Also:

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

getForceLobLookup

@Stability(Stable)
@Nullable
default Object getForceLobLookup()

Forces LOB lookup on inline LOB.

See Also:

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

getPassword

@Stability(Stable)
@Nullable
default String getPassword()

Endpoint connection password.

See Also:

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

getPort

@Stability(Stable)
@Nullable
default Number getPort()

Endpoint TCP port.

See Also:

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

getQuerySingleAlwaysOnNode

@Stability(Stable)
@Nullable
default Object getQuerySingleAlwaysOnNode()

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.

See Also:

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

getReadBackupOnly

@Stability(Stable)
@Nullable
default Object getReadBackupOnly()

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.

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 Also:

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

getSafeguardPolicy

@Stability(Stable)
@Nullable
default String getSafeguardPolicy()

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.

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 Also:

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

getSecretsManagerAccessRoleArn

@Stability(Stable)
@Nullable
default String getSecretsManagerAccessRoleArn()

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 .

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 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 , 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 Also:

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

getSecretsManagerSecretId

@Stability(Stable)
@Nullable
default String getSecretsManagerSecretId()

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

See Also:

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

getServerName

@Stability(Stable)
@Nullable
default String getServerName()

Fully qualified domain name of the endpoint.

For an Amazon RDS SQL Server instance, this is the output of DescribeDBInstances , in the [Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) .Address field.

See Also:

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

getTlogAccessMode

@Stability(Stable)
@Nullable
default String getTlogAccessMode()

Indicates the mode used to fetch CDC data.

See Also:

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

getTrimSpaceInChar

@Stability(Stable)
@Nullable
default Object getTrimSpaceInChar()

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 .

See Also:

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

getUseBcpFullLoad

@Stability(Stable)
@Nullable
default Object getUseBcpFullLoad()

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.

See Also:

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

getUsername

@Stability(Stable)
@Nullable
default String getUsername()

Endpoint connection user name.

See Also:

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

getUseThirdPartyBackupDevice

@Stability(Stable)
@Nullable
default Object getUseThirdPartyBackupDevice()

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

See Also:

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

builder

@Stability(Stable)
static CfnEndpoint.MicrosoftSqlServerSettingsProperty.Builder builder()

Returns:

a CfnEndpoint.MicrosoftSqlServerSettingsProperty.Builder of CfnEndpoint.MicrosoftSqlServerSettingsProperty