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 AWS DMS in the AWS Database Migration Service User Guide.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "CurrentLsn" :
String
, "MaxKBytesPerRead" :Integer
, "SecretsManagerAccessRoleArn" :String
, "SecretsManagerSecretId" :String
, "SetDataCaptureChanges" :Boolean
}
YAML
CurrentLsn:
String
MaxKBytesPerRead:Integer
SecretsManagerAccessRoleArn:String
SecretsManagerSecretId:String
SetDataCaptureChanges:Boolean
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
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 AWS DMS as the trusted entity and grants the required permissions to access the value in
SecretsManagerSecret
. The role must allow theiam:PassRole
action.SecretsManagerSecret
has the value ofthe AWS 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 forUserName
,Password
,ServerName
, andPort
. You can't specify both.For more information on creating this
SecretsManagerSecret
, the correspondingSecretsManagerAccessRoleArn
, and theSecretsManagerSecretId
that is required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS 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