Class CfnEndpoint.IbmDb2SettingsProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnEndpoint.IbmDb2SettingsProperty>
- Enclosing interface:
CfnEndpoint.IbmDb2SettingsProperty
CfnEndpoint.IbmDb2SettingsProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.currentLsn
(String currentLsn) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getCurrentLsn()
keepCsvFiles
(Boolean keepCsvFiles) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getKeepCsvFiles()
keepCsvFiles
(IResolvable keepCsvFiles) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getKeepCsvFiles()
loadTimeout
(Number loadTimeout) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getLoadTimeout()
maxFileSize
(Number maxFileSize) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getMaxFileSize()
maxKBytesPerRead
(Number maxKBytesPerRead) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getMaxKBytesPerRead()
secretsManagerAccessRoleArn
(String secretsManagerAccessRoleArn) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getSecretsManagerAccessRoleArn()
secretsManagerSecretId
(String secretsManagerSecretId) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getSecretsManagerSecretId()
setDataCaptureChanges
(Boolean setDataCaptureChanges) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getSetDataCaptureChanges()
setDataCaptureChanges
(IResolvable setDataCaptureChanges) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getSetDataCaptureChanges()
writeBufferSize
(Number writeBufferSize) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getWriteBufferSize()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
currentLsn
Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getCurrentLsn()
- Parameters:
currentLsn
- For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.- Returns:
this
-
keepCsvFiles
@Stability(Stable) public CfnEndpoint.IbmDb2SettingsProperty.Builder keepCsvFiles(Boolean keepCsvFiles) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getKeepCsvFiles()
- Parameters:
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. The default value is false.- Returns:
this
-
keepCsvFiles
@Stability(Stable) public CfnEndpoint.IbmDb2SettingsProperty.Builder keepCsvFiles(IResolvable keepCsvFiles) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getKeepCsvFiles()
- Parameters:
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. The default value is false.- Returns:
this
-
loadTimeout
@Stability(Stable) public CfnEndpoint.IbmDb2SettingsProperty.Builder loadTimeout(Number loadTimeout) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getLoadTimeout()
- Parameters:
loadTimeout
- 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:
this
-
maxFileSize
@Stability(Stable) public CfnEndpoint.IbmDb2SettingsProperty.Builder maxFileSize(Number maxFileSize) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getMaxFileSize()
- Parameters:
maxFileSize
- Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.- Returns:
this
-
maxKBytesPerRead
@Stability(Stable) public CfnEndpoint.IbmDb2SettingsProperty.Builder maxKBytesPerRead(Number maxKBytesPerRead) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getMaxKBytesPerRead()
- Parameters:
maxKBytesPerRead
- Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.- Returns:
this
-
secretsManagerAccessRoleArn
@Stability(Stable) public CfnEndpoint.IbmDb2SettingsProperty.Builder secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getSecretsManagerAccessRoleArn()
- Parameters:
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 inSecretsManagerSecret
. The role must allow theiam: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 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 .- Returns:
this
-
secretsManagerSecretId
@Stability(Stable) public CfnEndpoint.IbmDb2SettingsProperty.Builder secretsManagerSecretId(String secretsManagerSecretId) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getSecretsManagerSecretId()
- Parameters:
secretsManagerSecretId
- The full ARN, partial ARN, or display name of theSecretsManagerSecret
that contains the IBMDB2 endpoint connection details.- Returns:
this
-
setDataCaptureChanges
@Stability(Stable) public CfnEndpoint.IbmDb2SettingsProperty.Builder setDataCaptureChanges(Boolean setDataCaptureChanges) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getSetDataCaptureChanges()
- Parameters:
setDataCaptureChanges
- Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.- Returns:
this
-
setDataCaptureChanges
@Stability(Stable) public CfnEndpoint.IbmDb2SettingsProperty.Builder setDataCaptureChanges(IResolvable setDataCaptureChanges) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getSetDataCaptureChanges()
- Parameters:
setDataCaptureChanges
- Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.- Returns:
this
-
writeBufferSize
@Stability(Stable) public CfnEndpoint.IbmDb2SettingsProperty.Builder writeBufferSize(Number writeBufferSize) Sets the value ofCfnEndpoint.IbmDb2SettingsProperty.getWriteBufferSize()
- Parameters:
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).- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnEndpoint.IbmDb2SettingsProperty>
- Returns:
- a new instance of
CfnEndpoint.IbmDb2SettingsProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-