Package software.amazon.awscdk.cfnpropertymixins.services.dms

Class CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.dms.CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty.Jsii$Proxy

All Implemented Interfaces:

CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

@Stability(Stable)
@Internal
public static final class CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

An implementation for CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.dms.CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty.Builder, CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

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

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty.Builder.

Method Details

getBcpPacketSize

public final Number getBcpPacketSize()

Description copied from interface: CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

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

Specified by:

getBcpPacketSize in interface CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

See Also:

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

getControlTablesFileGroup

public final String getControlTablesFileGroup()

Description copied from interface: CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

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.

Specified by:

getControlTablesFileGroup in interface CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

See Also:

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

getDatabaseName

public final String getDatabaseName()

Description copied from interface: CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

Database name for the endpoint.

Specified by:

getDatabaseName in interface CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

See Also:

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

getForceLobLookup

public final Object getForceLobLookup()

Description copied from interface: CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

Forces LOB lookup on inline LOB.

Returns union: either Boolean or IResolvable

Specified by:

getForceLobLookup in interface CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

See Also:

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

getPassword

public final String getPassword()

Description copied from interface: CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

Endpoint connection password.

Specified by:

getPassword in interface CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

See Also:

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

getPort

public final Number getPort()

Description copied from interface: CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

Endpoint TCP port.

Specified by:

getPort in interface CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

See Also:

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

getQuerySingleAlwaysOnNode

public final Object getQuerySingleAlwaysOnNode()

Description copied from interface: CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

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.

Returns union: either Boolean or IResolvable

Specified by:

getQuerySingleAlwaysOnNode in interface CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

See Also:

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

getReadBackupOnly

public final Object getReadBackupOnly()

Description copied from interface: CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

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.

Returns union: either Boolean or IResolvable

Specified by:

getReadBackupOnly in interface CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

See Also:

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

getSafeguardPolicy

public final String getSafeguardPolicy()

Description copied from interface: CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

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.

Specified by:

getSafeguardPolicy in interface CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

See Also:

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

getSecretsManagerAccessRoleArn

public final String getSecretsManagerAccessRoleArn()

Description copied from interface: CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

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 .

Specified by:

getSecretsManagerAccessRoleArn in interface CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

See Also:

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

getSecretsManagerSecretId

public final String getSecretsManagerSecretId()

Description copied from interface: CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

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

Specified by:

getSecretsManagerSecretId in interface CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

See Also:

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

getServerName

public final String getServerName()

Description copied from interface: CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

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.

Specified by:

getServerName in interface CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

See Also:

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

getTlogAccessMode

public final String getTlogAccessMode()

Description copied from interface: CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

Indicates the mode used to fetch CDC data.

Specified by:

getTlogAccessMode in interface CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

See Also:

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

getTrimSpaceInChar

public final Object getTrimSpaceInChar()

Description copied from interface: CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

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 .

Returns union: either Boolean or IResolvable

Specified by:

getTrimSpaceInChar in interface CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

See Also:

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

getUseBcpFullLoad

public final Object getUseBcpFullLoad()

Description copied from interface: CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

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.

Returns union: either Boolean or IResolvable

Specified by:

getUseBcpFullLoad in interface CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

See Also:

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

getUsername

public final String getUsername()

Description copied from interface: CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

Endpoint connection user name.

Specified by:

getUsername in interface CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

See Also:

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

getUseThirdPartyBackupDevice

public final Object getUseThirdPartyBackupDevice()

Description copied from interface: CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

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

Returns union: either Boolean or IResolvable

Specified by:

getUseThirdPartyBackupDevice in interface CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object