Class CfnEndpointPropsMixin.IbmDb2SettingsProperty

Provides information that defines an IBMDB2 endpoint.

Inheritance

object

CfnEndpointPropsMixin.IbmDb2SettingsProperty

Implements

CfnEndpointPropsMixin.IIbmDb2SettingsProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.DMS.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnEndpointPropsMixin.IbmDb2SettingsProperty : CfnEndpointPropsMixin.IIbmDb2SettingsProperty

Syntax (vb)

Public Class CfnEndpointPropsMixin.IbmDb2SettingsProperty Implements CfnEndpointPropsMixin.IIbmDb2SettingsProperty

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.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.Mixins.Preview.AWS.DMS.Mixins;

             var ibmDb2SettingsProperty = new IbmDb2SettingsProperty {
                 CurrentLsn = "currentLsn",
                 KeepCsvFiles = false,
                 LoadTimeout = 123,
                 MaxFileSize = 123,
                 MaxKBytesPerRead = 123,
                 SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
                 SecretsManagerSecretId = "secretsManagerSecretId",
                 SetDataCaptureChanges = false,
                 WriteBufferSize = 123
             };

Synopsis

Constructors

IbmDb2SettingsProperty()

Provides information that defines an IBMDB2 endpoint.

Properties

CurrentLsn	For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
KeepCsvFiles	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.
LoadTimeout	The amount of time (in milliseconds) before AWS DMS times out operations performed by DMS on the Db2 target.
MaxFileSize	Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.
MaxKBytesPerRead	Maximum number of bytes per read, as a NUMBER value.
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 IBMDB2 endpoint connection details.
SetDataCaptureChanges	Enables ongoing replication (CDC) as a BOOLEAN value.
WriteBufferSize	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).

Constructors

IbmDb2SettingsProperty()

Provides information that defines an IBMDB2 endpoint.

public IbmDb2SettingsProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.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.Mixins.Preview.AWS.DMS.Mixins;

             var ibmDb2SettingsProperty = new IbmDb2SettingsProperty {
                 CurrentLsn = "currentLsn",
                 KeepCsvFiles = false,
                 LoadTimeout = 123,
                 MaxFileSize = 123,
                 MaxKBytesPerRead = 123,
                 SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
                 SecretsManagerSecretId = "secretsManagerSecretId",
                 SetDataCaptureChanges = false,
                 WriteBufferSize = 123
             };

Properties

CurrentLsn

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

public string? CurrentLsn { get; set; }

Property Value

string

Remarks

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

KeepCsvFiles

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.

public object? KeepCsvFiles { get; set; }

Property Value

object

Remarks

The default value is false.

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

Type union: either bool or IResolvable

LoadTimeout

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

public double? LoadTimeout { get; set; }

Property Value

double?

Remarks

The default value is 1200 (20 minutes).

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

MaxFileSize

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

public double? MaxFileSize { get; set; }

Property Value

double?

Remarks

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

MaxKBytesPerRead

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

public double? MaxKBytesPerRead { get; set; }

Property Value

double?

Remarks

The default is 64 KB.

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

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 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 <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-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-secretsmanageraccessrolearn

SecretsManagerSecretId

The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the IBMDB2 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-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-secretsmanagersecretid

SetDataCaptureChanges

Enables ongoing replication (CDC) as a BOOLEAN value.

public object? SetDataCaptureChanges { get; set; }

Property Value

object

Remarks

The default is true.

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

Type union: either bool or IResolvable

WriteBufferSize

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

public double? WriteBufferSize { get; set; }