AWS::DMS::Endpoint IbmDb2Settings - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::DMS::Endpoint IbmDb2Settings

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 Amazon DMS in the Amazon Database Migration Service User Guide.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "CurrentLsn" : String,
  "KeepCsvFiles" : Boolean,
  "LoadTimeout" : Integer,
  "MaxFileSize" : Integer,
  "MaxKBytesPerRead" : Integer,
  "SecretsManagerAccessRoleArn" : String,
  "SecretsManagerSecretId" : String,
  "SetDataCaptureChanges" : Boolean,
  "WriteBufferSize" : Integer
}

Properties

CurrentLsn

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

Required: No

Type: String

Update requires: No interruption

KeepCsvFiles

If true, Amazon 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.

Required: No

Type: Boolean

Update requires: No interruption

LoadTimeout

The amount of time (in milliseconds) before Amazon DMS times out operations performed by DMS on the Db2 target. The default value is 1200 (20 minutes).

Required: No

Type: Integer

Update requires: No interruption

MaxFileSize

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

Required: No

Type: Integer

Update requires: No interruption

MaxKBytesPerRead

Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.

Required: No

Type: Integer

Update requires: No interruption

SecretsManagerAccessRoleArn

The full Amazon Resource Name (ARN) of the IAM role that specifies Amazon 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 Amazon Secrets Manager secret that allows access to the Db2 LUW endpoint.

Note

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 Amazon Database Migration Service resources in the Amazon Database Migration Service User Guide.

Required: No

Type: String

Update requires: No interruption

SecretsManagerSecretId

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

Required: No

Type: String

Update requires: No interruption

SetDataCaptureChanges

Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.

Required: No

Type: Boolean

Update requires: No interruption

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

Required: No

Type: Integer

Update requires: No interruption