Interface PostgreSQLSettings.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<PostgreSQLSettings.Builder,
,PostgreSQLSettings> SdkBuilder<PostgreSQLSettings.Builder,
,PostgreSQLSettings> SdkPojo
- Enclosing class:
PostgreSQLSettings
-
Method Summary
Modifier and TypeMethodDescriptionafterConnectScript
(String afterConnectScript) For use with change data capture (CDC) only, this attribute has DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.babelfishDatabaseName
(String babelfishDatabaseName) The Babelfish for Aurora PostgreSQL database name for the endpoint.captureDdls
(Boolean captureDdls) To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts.databaseMode
(String databaseMode) Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.databaseMode
(DatabaseMode databaseMode) Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.databaseName
(String databaseName) Database name for the endpoint.ddlArtifactsSchema
(String ddlArtifactsSchema) The schema in which the operational DDL database artifacts are created.executeTimeout
(Integer executeTimeout) Sets the client statement timeout for the PostgreSQL instance, in seconds.failTasksOnLobTruncation
(Boolean failTasksOnLobTruncation) When set totrue
, this value causes a task to fail if the actual size of a LOB column is greater than the specifiedLobMaxSize
.heartbeatEnable
(Boolean heartbeatEnable) The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.heartbeatFrequency
(Integer heartbeatFrequency) Sets the WAL heartbeat frequency (in minutes).heartbeatSchema
(String heartbeatSchema) Sets the schema in which the heartbeat artifacts are created.mapBooleanAsBoolean
(Boolean mapBooleanAsBoolean) When true, lets PostgreSQL migrate the boolean type as boolean.mapJsonbAsClob
(Boolean mapJsonbAsClob) When true, DMS migrates JSONB values as CLOB.mapLongVarcharAs
(String mapLongVarcharAs) When true, DMS migrates LONG values as VARCHAR.mapLongVarcharAs
(LongVarcharMappingType mapLongVarcharAs) When true, DMS migrates LONG values as VARCHAR.maxFileSize
(Integer maxFileSize) Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.Endpoint connection password.pluginName
(String pluginName) Specifies the plugin to use to create a replication slot.pluginName
(PluginNameValue pluginName) Specifies the plugin to use to create a replication slot.Endpoint TCP port.secretsManagerAccessRoleArn
(String secretsManagerAccessRoleArn) The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value inSecretsManagerSecret
.secretsManagerSecretId
(String secretsManagerSecretId) The full ARN, partial ARN, or friendly name of theSecretsManagerSecret
that contains the PostgreSQL endpoint connection details.serverName
(String serverName) The host name of the endpoint database.Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.trimSpaceInChar
(Boolean trimSpaceInChar) Use theTrimSpaceInChar
source endpoint setting to trim data on CHAR and NCHAR data types during migration.Endpoint connection user name.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
afterConnectScript
For use with change data capture (CDC) only, this attribute has DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.
Example:
afterConnectScript=SET session_replication_role='replica'
- Parameters:
afterConnectScript
- For use with change data capture (CDC) only, this attribute has DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.Example:
afterConnectScript=SET session_replication_role='replica'
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
captureDdls
To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.
If this value is set to
N
, you don't have to create tables or triggers on the source database.- Parameters:
captureDdls
- To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.If this value is set to
N
, you don't have to create tables or triggers on the source database.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxFileSize
Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
Example:
maxFileSize=512
- Parameters:
maxFileSize
- Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.Example:
maxFileSize=512
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
databaseName
Database name for the endpoint.
- Parameters:
databaseName
- Database name for the endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ddlArtifactsSchema
The schema in which the operational DDL database artifacts are created.
Example:
ddlArtifactsSchema=xyzddlschema;
- Parameters:
ddlArtifactsSchema
- The schema in which the operational DDL database artifacts are created.Example:
ddlArtifactsSchema=xyzddlschema;
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
executeTimeout
Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
Example:
executeTimeout=100;
- Parameters:
executeTimeout
- Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.Example:
executeTimeout=100;
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
failTasksOnLobTruncation
When set to
true
, this value causes a task to fail if the actual size of a LOB column is greater than the specifiedLobMaxSize
.If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
- Parameters:
failTasksOnLobTruncation
- When set totrue
, this value causes a task to fail if the actual size of a LOB column is greater than the specifiedLobMaxSize
.If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
heartbeatEnable
The write-ahead log (WAL) heartbeat feature mimics a dummy transaction. By doing this, it prevents idle logical replication slots from holding onto old WAL logs, which can result in storage full situations on the source. This heartbeat keeps
restart_lsn
moving and prevents storage full scenarios.- Parameters:
heartbeatEnable
- The write-ahead log (WAL) heartbeat feature mimics a dummy transaction. By doing this, it prevents idle logical replication slots from holding onto old WAL logs, which can result in storage full situations on the source. This heartbeat keepsrestart_lsn
moving and prevents storage full scenarios.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
heartbeatSchema
Sets the schema in which the heartbeat artifacts are created.
- Parameters:
heartbeatSchema
- Sets the schema in which the heartbeat artifacts are created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
heartbeatFrequency
Sets the WAL heartbeat frequency (in minutes).
- Parameters:
heartbeatFrequency
- Sets the WAL heartbeat frequency (in minutes).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
password
Endpoint connection password.
- Parameters:
password
- Endpoint connection password.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
port
Endpoint TCP port. The default is 5432.
- Parameters:
port
- Endpoint TCP port. The default is 5432.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serverName
The host name of the endpoint database.
For an Amazon RDS PostgreSQL instance, this is the output of DescribeDBInstances, in the
Endpoint.Address
field.For an Aurora PostgreSQL instance, this is the output of DescribeDBClusters, in the
Endpoint
field.- Parameters:
serverName
- The host name of the endpoint database.For an Amazon RDS PostgreSQL instance, this is the output of DescribeDBInstances, in the
Endpoint.Address
field.For an Aurora PostgreSQL instance, this is the output of DescribeDBClusters, in the
Endpoint
field.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
username
Endpoint connection user name.
- Parameters:
username
- Endpoint connection user name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
slotName
Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.
When used with the
CdcStartPosition
request parameter for the DMS API , this attribute also makes it possible to use native CDC start points. DMS verifies that the specified logical replication slot exists before starting the CDC load task. It also verifies that the task was created with a valid setting ofCdcStartPosition
. If the specified slot doesn't exist or the task doesn't have a validCdcStartPosition
setting, DMS raises an error.For more information about setting the
CdcStartPosition
request parameter, see Determining a CDC native start point in the Database Migration Service User Guide. For more information about usingCdcStartPosition
, see CreateReplicationTask, StartReplicationTask, and ModifyReplicationTask.- Parameters:
slotName
- Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.When used with the
CdcStartPosition
request parameter for the DMS API , this attribute also makes it possible to use native CDC start points. DMS verifies that the specified logical replication slot exists before starting the CDC load task. It also verifies that the task was created with a valid setting ofCdcStartPosition
. If the specified slot doesn't exist or the task doesn't have a validCdcStartPosition
setting, DMS raises an error.For more information about setting the
CdcStartPosition
request parameter, see Determining a CDC native start point in the Database Migration Service User Guide. For more information about usingCdcStartPosition
, see CreateReplicationTask, StartReplicationTask, and ModifyReplicationTask.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
pluginName
Specifies the plugin to use to create a replication slot.
- Parameters:
pluginName
- Specifies the plugin to use to create a replication slot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
pluginName
Specifies the plugin to use to create a replication slot.
- Parameters:
pluginName
- Specifies the plugin to use to create a replication slot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
secretsManagerAccessRoleArn
The full Amazon Resource Name (ARN) of the IAM role that specifies 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 of the Amazon Web Services Secrets Manager secret that allows access to the PostgreSQL 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 thisSecretsManagerSecret
and theSecretsManagerAccessRoleArn
andSecretsManagerSecretId
required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.- Parameters:
secretsManagerAccessRoleArn
- The full Amazon Resource Name (ARN) of the IAM role that specifies 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 of the Amazon Web Services Secrets Manager secret that allows access to the PostgreSQL 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 thisSecretsManagerSecret
and theSecretsManagerAccessRoleArn
andSecretsManagerSecretId
required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
secretsManagerSecretId
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret
that contains the PostgreSQL endpoint connection details.- Parameters:
secretsManagerSecretId
- The full ARN, partial ARN, or friendly name of theSecretsManagerSecret
that contains the PostgreSQL endpoint connection details.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trimSpaceInChar
Use the
TrimSpaceInChar
source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value istrue
.- Parameters:
trimSpaceInChar
- Use theTrimSpaceInChar
source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value istrue
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mapBooleanAsBoolean
When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans as
varchar(5)
. You must set this setting on both the source and target endpoints for it to take effect.- Parameters:
mapBooleanAsBoolean
- When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans asvarchar(5)
. You must set this setting on both the source and target endpoints for it to take effect.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mapJsonbAsClob
When true, DMS migrates JSONB values as CLOB.
- Parameters:
mapJsonbAsClob
- When true, DMS migrates JSONB values as CLOB.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mapLongVarcharAs
When true, DMS migrates LONG values as VARCHAR.
- Parameters:
mapLongVarcharAs
- When true, DMS migrates LONG values as VARCHAR.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
mapLongVarcharAs
When true, DMS migrates LONG values as VARCHAR.
- Parameters:
mapLongVarcharAs
- When true, DMS migrates LONG values as VARCHAR.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
databaseMode
Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
- Parameters:
databaseMode
- Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
databaseMode
Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
- Parameters:
databaseMode
- Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
babelfishDatabaseName
The Babelfish for Aurora PostgreSQL database name for the endpoint.
- Parameters:
babelfishDatabaseName
- The Babelfish for Aurora PostgreSQL database name for the endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-