Class: AWSCDK::DMS::CfnEndpoint::IbmDB2SettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
dms/cfn_endpoint.rb

Overview

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 .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(current_lsn: nil, keep_csv_files: nil, load_timeout: nil, max_file_size: nil, max_k_bytes_per_read: nil, secrets_manager_access_role_arn: nil, secrets_manager_secret_id: nil, set_data_capture_changes: nil, write_buffer_size: nil) ⇒ IbmDB2SettingsProperty

Returns a new instance of IbmDB2SettingsProperty.

Parameters:

  • current_lsn (String, nil) (defaults to: nil) —

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

  • keep_csv_files (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    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.

  • load_timeout (Numeric, nil) (defaults to: nil) —

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

  • max_file_size (Numeric, nil) (defaults to: nil) —

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

  • max_k_bytes_per_read (Numeric, nil) (defaults to: nil) —

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

  • secrets_manager_access_role_arn (String, nil) (defaults to: nil) —

    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 .

  • secrets_manager_secret_id (String, nil) (defaults to: nil) —

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

  • set_data_capture_changes (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Enables ongoing replication (CDC) as a BOOLEAN value.

  • write_buffer_size (Numeric, nil) (defaults to: nil) —

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



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
 
# File 'dms/cfn_endpoint.rb', line 1335

def initialize(current_lsn: nil, keep_csv_files: nil, load_timeout: nil, max_file_size: nil, max_k_bytes_per_read: nil, secrets_manager_access_role_arn: nil, secrets_manager_secret_id: nil, set_data_capture_changes: nil, write_buffer_size: nil)
  @current_lsn = current_lsn
  Jsii::Type.check_type(@current_lsn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "currentLsn") unless @current_lsn.nil?
  @keep_csv_files = keep_csv_files
  Jsii::Type.check_type(@keep_csv_files, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "keepCsvFiles") unless @keep_csv_files.nil?
  @load_timeout = load_timeout
  Jsii::Type.check_type(@load_timeout, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "loadTimeout") unless @load_timeout.nil?
  @max_file_size = max_file_size
  Jsii::Type.check_type(@max_file_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxFileSize") unless @max_file_size.nil?
  @max_k_bytes_per_read = max_k_bytes_per_read
  Jsii::Type.check_type(@max_k_bytes_per_read, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxKBytesPerRead") unless @max_k_bytes_per_read.nil?
  @secrets_manager_access_role_arn = secrets_manager_access_role_arn
  Jsii::Type.check_type(@secrets_manager_access_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretsManagerAccessRoleArn") unless @secrets_manager_access_role_arn.nil?
  @secrets_manager_secret_id = secrets_manager_secret_id
  Jsii::Type.check_type(@secrets_manager_secret_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretsManagerSecretId") unless @secrets_manager_secret_id.nil?
  @set_data_capture_changes = set_data_capture_changes
  Jsii::Type.check_type(@set_data_capture_changes, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "setDataCaptureChanges") unless @set_data_capture_changes.nil?
  @write_buffer_size = write_buffer_size
  Jsii::Type.check_type(@write_buffer_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "writeBufferSize") unless @write_buffer_size.nil?
end

Instance Attribute Details

#current_lsn ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1360
1361
1362
 
# File 'dms/cfn_endpoint.rb', line 1360

def current_lsn
  @current_lsn
end

#keep_csv_files ⇒ Boolean, ... (readonly)

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.

Returns:

See Also:



1367
1368
1369
 
# File 'dms/cfn_endpoint.rb', line 1367

def keep_csv_files
  @keep_csv_files
end

#load_timeout ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



1374
1375
1376
 
# File 'dms/cfn_endpoint.rb', line 1374

def load_timeout
  @load_timeout
end

#max_file_size ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



1379
1380
1381
 
# File 'dms/cfn_endpoint.rb', line 1379

def max_file_size
  @max_file_size
end

#max_k_bytes_per_read ⇒ Numeric? (readonly)

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

The default is 64 KB.

Returns:

  • (Numeric, nil)

See Also:



1386
1387
1388
 
# File 'dms/cfn_endpoint.rb', line 1386

def max_k_bytes_per_read
  @max_k_bytes_per_read
end

#secrets_manager_access_role_arn ⇒ String? (readonly)

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 .

Returns:

  • (String, nil)

See Also:



1397
1398
1399
 
# File 'dms/cfn_endpoint.rb', line 1397

def secrets_manager_access_role_arn
  @secrets_manager_access_role_arn
end

#secrets_manager_secret_id ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1402
1403
1404
 
# File 'dms/cfn_endpoint.rb', line 1402

def secrets_manager_secret_id
  @secrets_manager_secret_id
end

#set_data_capture_changes ⇒ Boolean, ... (readonly)

Enables ongoing replication (CDC) as a BOOLEAN value.

The default is true.

Returns:

See Also:



1409
1410
1411
 
# File 'dms/cfn_endpoint.rb', line 1409

def set_data_capture_changes
  @set_data_capture_changes
end

#write_buffer_size ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



1414
1415
1416
 
# File 'dms/cfn_endpoint.rb', line 1414

def write_buffer_size
  @write_buffer_size
end

Class Method Details

.jsii_properties ⇒ Object 



1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
 
# File 'dms/cfn_endpoint.rb', line 1416

def self.jsii_properties
  {
    :current_lsn => "currentLsn",
    :keep_csv_files => "keepCsvFiles",
    :load_timeout => "loadTimeout",
    :max_file_size => "maxFileSize",
    :max_k_bytes_per_read => "maxKBytesPerRead",
    :secrets_manager_access_role_arn => "secretsManagerAccessRoleArn",
    :secrets_manager_secret_id => "secretsManagerSecretId",
    :set_data_capture_changes => "setDataCaptureChanges",
    :write_buffer_size => "writeBufferSize",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
 
# File 'dms/cfn_endpoint.rb', line 1430

def to_jsii
  result = {}
  result.merge!({
    "currentLsn" => @current_lsn,
    "keepCsvFiles" => @keep_csv_files,
    "loadTimeout" => @load_timeout,
    "maxFileSize" => @max_file_size,
    "maxKBytesPerRead" => @max_k_bytes_per_read,
    "secretsManagerAccessRoleArn" => @secrets_manager_access_role_arn,
    "secretsManagerSecretId" => @secrets_manager_secret_id,
    "setDataCaptureChanges" => @set_data_capture_changes,
    "writeBufferSize" => @write_buffer_size,
  })
  result.compact
end