Package software.amazon.awscdk.services.dms

Interface CfnEndpoint.IbmDb2SettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpoint.IbmDb2SettingsProperty.Jsii$Proxy

Enclosing class:

CfnEndpoint

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

Provides information that defines an IBMDB2 endpoint.

This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about other available settings, see Extra connection attributes when using Db2 LUW as a source 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.*;
 IbmDb2SettingsProperty ibmDb2SettingsProperty = IbmDb2SettingsProperty.builder()
         .currentLsn("currentLsn")
         .keepCsvFiles(false)
         .loadTimeout(123)
         .maxFileSize(123)
         .maxKBytesPerRead(123)
         .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
         .secretsManagerSecretId("secretsManagerSecretId")
         .setDataCaptureChanges(false)
         .writeBufferSize(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnEndpoint.IbmDb2SettingsProperty.Builder	builder()
default String	getCurrentLsn()	For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
default Object	getKeepCsvFiles()	If true, AWS DMS saves any .csv files to the Db2 LUW target that were used to replicate data.
default Number	getLoadTimeout()	The amount of time (in milliseconds) before AWS DMS times out operations performed by DMS on the Db2 target.
default Number	getMaxFileSize()	Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.
default Number	getMaxKBytesPerRead()	Maximum number of bytes per read, as a NUMBER value.
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 IBMDB2 endpoint connection details.
default Object	getSetDataCaptureChanges()	Enables ongoing replication (CDC) as a BOOLEAN value.
default Number	getWriteBufferSize()	The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk on the DMS replication instance.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCurrentLsn

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

For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.

See Also:

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

getKeepCsvFiles

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

If true, AWS DMS saves any .csv files to the Db2 LUW target that were used to replicate data. DMS uses these files for analysis and troubleshooting.

The default value is false.

See Also:

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

getLoadTimeout

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

The amount of time (in milliseconds) before AWS DMS times out operations performed by DMS on the Db2 target.

The default value is 1200 (20 minutes).

See Also:

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

getMaxFileSize

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

Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.

See Also:

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

getMaxKBytesPerRead

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

Maximum number of bytes per read, as a NUMBER value.

The default is 64 KB.

See Also:

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

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 ofthe AWS Secrets Manager secret that allows access to the Db2 LUW 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-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-secretsmanageraccessrolearn

getSecretsManagerSecretId

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

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

See Also:

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

getSetDataCaptureChanges

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

Enables ongoing replication (CDC) as a BOOLEAN value.

The default is true.

See Also:

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

getWriteBufferSize

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

The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk on the DMS replication instance. The default value is 1024 (1 MB).

See Also:

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

builder

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

Returns:

a CfnEndpoint.IbmDb2SettingsProperty.Builder of CfnEndpoint.IbmDb2SettingsProperty