@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class PostgreSQLSettings extends Object implements Serializable, Cloneable, StructuredPojo
Provides information that defines a PostgreSQL endpoint.
Constructor and Description |
---|
PostgreSQLSettings() |
Modifier and Type | Method and Description |
---|---|
PostgreSQLSettings |
clone() |
boolean |
equals(Object obj) |
String |
getAfterConnectScript()
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.
|
String |
getBabelfishDatabaseName()
The Babelfish for Aurora PostgreSQL database name for the endpoint.
|
Boolean |
getCaptureDdls()
To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts.
|
String |
getDatabaseMode()
Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require
some additional configuration, such as Babelfish endpoints.
|
String |
getDatabaseName()
Database name for the endpoint.
|
String |
getDdlArtifactsSchema()
The schema in which the operational DDL database artifacts are created.
|
Integer |
getExecuteTimeout()
Sets the client statement timeout for the PostgreSQL instance, in seconds.
|
Boolean |
getFailTasksOnLobTruncation()
When set to
true , this value causes a task to fail if the actual size of a LOB column is greater
than the specified LobMaxSize . |
Boolean |
getHeartbeatEnable()
The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.
|
Integer |
getHeartbeatFrequency()
Sets the WAL heartbeat frequency (in minutes).
|
String |
getHeartbeatSchema()
Sets the schema in which the heartbeat artifacts are created.
|
Boolean |
getMapBooleanAsBoolean()
When true, lets PostgreSQL migrate the boolean type as boolean.
|
Boolean |
getMapJsonbAsClob()
When true, DMS migrates JSONB values as CLOB.
|
String |
getMapLongVarcharAs()
When true, DMS migrates LONG values as VARCHAR.
|
Integer |
getMaxFileSize()
Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
|
String |
getPassword()
Endpoint connection password.
|
String |
getPluginName()
Specifies the plugin to use to create a replication slot.
|
Integer |
getPort()
Endpoint TCP port.
|
String |
getSecretsManagerAccessRoleArn()
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 . |
String |
getSecretsManagerSecretId()
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret that contains the PostgreSQL
endpoint connection details. |
String |
getServerName()
The host name of the endpoint database.
|
String |
getSlotName()
Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the
PostgreSQL source instance.
|
Boolean |
getTrimSpaceInChar()
Use the
TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during
migration. |
String |
getUsername()
Endpoint connection user name.
|
int |
hashCode() |
Boolean |
isCaptureDdls()
To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts.
|
Boolean |
isFailTasksOnLobTruncation()
When set to
true , this value causes a task to fail if the actual size of a LOB column is greater
than the specified LobMaxSize . |
Boolean |
isHeartbeatEnable()
The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.
|
Boolean |
isMapBooleanAsBoolean()
When true, lets PostgreSQL migrate the boolean type as boolean.
|
Boolean |
isMapJsonbAsClob()
When true, DMS migrates JSONB values as CLOB.
|
Boolean |
isTrimSpaceInChar()
Use the
TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during
migration. |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAfterConnectScript(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.
|
void |
setBabelfishDatabaseName(String babelfishDatabaseName)
The Babelfish for Aurora PostgreSQL database name for the endpoint.
|
void |
setCaptureDdls(Boolean captureDdls)
To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts.
|
void |
setDatabaseMode(String databaseMode)
Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require
some additional configuration, such as Babelfish endpoints.
|
void |
setDatabaseName(String databaseName)
Database name for the endpoint.
|
void |
setDdlArtifactsSchema(String ddlArtifactsSchema)
The schema in which the operational DDL database artifacts are created.
|
void |
setExecuteTimeout(Integer executeTimeout)
Sets the client statement timeout for the PostgreSQL instance, in seconds.
|
void |
setFailTasksOnLobTruncation(Boolean failTasksOnLobTruncation)
When set to
true , this value causes a task to fail if the actual size of a LOB column is greater
than the specified LobMaxSize . |
void |
setHeartbeatEnable(Boolean heartbeatEnable)
The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.
|
void |
setHeartbeatFrequency(Integer heartbeatFrequency)
Sets the WAL heartbeat frequency (in minutes).
|
void |
setHeartbeatSchema(String heartbeatSchema)
Sets the schema in which the heartbeat artifacts are created.
|
void |
setMapBooleanAsBoolean(Boolean mapBooleanAsBoolean)
When true, lets PostgreSQL migrate the boolean type as boolean.
|
void |
setMapJsonbAsClob(Boolean mapJsonbAsClob)
When true, DMS migrates JSONB values as CLOB.
|
void |
setMapLongVarcharAs(String mapLongVarcharAs)
When true, DMS migrates LONG values as VARCHAR.
|
void |
setMaxFileSize(Integer maxFileSize)
Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
|
void |
setPassword(String password)
Endpoint connection password.
|
void |
setPluginName(String pluginName)
Specifies the plugin to use to create a replication slot.
|
void |
setPort(Integer port)
Endpoint TCP port.
|
void |
setSecretsManagerAccessRoleArn(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 in
SecretsManagerSecret . |
void |
setSecretsManagerSecretId(String secretsManagerSecretId)
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret that contains the PostgreSQL
endpoint connection details. |
void |
setServerName(String serverName)
The host name of the endpoint database.
|
void |
setSlotName(String slotName)
Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the
PostgreSQL source instance.
|
void |
setTrimSpaceInChar(Boolean trimSpaceInChar)
Use the
TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during
migration. |
void |
setUsername(String username)
Endpoint connection user name.
|
String |
toString()
Returns a string representation of this object.
|
PostgreSQLSettings |
withAfterConnectScript(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.
|
PostgreSQLSettings |
withBabelfishDatabaseName(String babelfishDatabaseName)
The Babelfish for Aurora PostgreSQL database name for the endpoint.
|
PostgreSQLSettings |
withCaptureDdls(Boolean captureDdls)
To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts.
|
PostgreSQLSettings |
withDatabaseMode(DatabaseMode databaseMode)
Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require
some additional configuration, such as Babelfish endpoints.
|
PostgreSQLSettings |
withDatabaseMode(String databaseMode)
Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require
some additional configuration, such as Babelfish endpoints.
|
PostgreSQLSettings |
withDatabaseName(String databaseName)
Database name for the endpoint.
|
PostgreSQLSettings |
withDdlArtifactsSchema(String ddlArtifactsSchema)
The schema in which the operational DDL database artifacts are created.
|
PostgreSQLSettings |
withExecuteTimeout(Integer executeTimeout)
Sets the client statement timeout for the PostgreSQL instance, in seconds.
|
PostgreSQLSettings |
withFailTasksOnLobTruncation(Boolean failTasksOnLobTruncation)
When set to
true , this value causes a task to fail if the actual size of a LOB column is greater
than the specified LobMaxSize . |
PostgreSQLSettings |
withHeartbeatEnable(Boolean heartbeatEnable)
The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.
|
PostgreSQLSettings |
withHeartbeatFrequency(Integer heartbeatFrequency)
Sets the WAL heartbeat frequency (in minutes).
|
PostgreSQLSettings |
withHeartbeatSchema(String heartbeatSchema)
Sets the schema in which the heartbeat artifacts are created.
|
PostgreSQLSettings |
withMapBooleanAsBoolean(Boolean mapBooleanAsBoolean)
When true, lets PostgreSQL migrate the boolean type as boolean.
|
PostgreSQLSettings |
withMapJsonbAsClob(Boolean mapJsonbAsClob)
When true, DMS migrates JSONB values as CLOB.
|
PostgreSQLSettings |
withMapLongVarcharAs(LongVarcharMappingType mapLongVarcharAs)
When true, DMS migrates LONG values as VARCHAR.
|
PostgreSQLSettings |
withMapLongVarcharAs(String mapLongVarcharAs)
When true, DMS migrates LONG values as VARCHAR.
|
PostgreSQLSettings |
withMaxFileSize(Integer maxFileSize)
Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
|
PostgreSQLSettings |
withPassword(String password)
Endpoint connection password.
|
PostgreSQLSettings |
withPluginName(PluginNameValue pluginName)
Specifies the plugin to use to create a replication slot.
|
PostgreSQLSettings |
withPluginName(String pluginName)
Specifies the plugin to use to create a replication slot.
|
PostgreSQLSettings |
withPort(Integer port)
Endpoint TCP port.
|
PostgreSQLSettings |
withSecretsManagerAccessRoleArn(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 in
SecretsManagerSecret . |
PostgreSQLSettings |
withSecretsManagerSecretId(String secretsManagerSecretId)
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret that contains the PostgreSQL
endpoint connection details. |
PostgreSQLSettings |
withServerName(String serverName)
The host name of the endpoint database.
|
PostgreSQLSettings |
withSlotName(String slotName)
Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the
PostgreSQL source instance.
|
PostgreSQLSettings |
withTrimSpaceInChar(Boolean trimSpaceInChar)
Use the
TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during
migration. |
PostgreSQLSettings |
withUsername(String username)
Endpoint connection user name.
|
public void setAfterConnectScript(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.
Example: afterConnectScript=SET session_replication_role='replica'
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'
public String getAfterConnectScript()
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'
Example: afterConnectScript=SET session_replication_role='replica'
public PostgreSQLSettings withAfterConnectScript(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.
Example: afterConnectScript=SET session_replication_role='replica'
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'
public void setCaptureDdls(Boolean 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.
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.
public Boolean getCaptureDdls()
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.
If this value is set to N
, you don't have to create tables or triggers on the source
database.
public PostgreSQLSettings withCaptureDdls(Boolean 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.
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.
public Boolean isCaptureDdls()
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.
If this value is set to N
, you don't have to create tables or triggers on the source
database.
public void setMaxFileSize(Integer maxFileSize)
Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
Example: maxFileSize=512
maxFileSize
- Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
Example: maxFileSize=512
public Integer getMaxFileSize()
Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
Example: maxFileSize=512
Example: maxFileSize=512
public PostgreSQLSettings withMaxFileSize(Integer maxFileSize)
Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
Example: maxFileSize=512
maxFileSize
- Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
Example: maxFileSize=512
public void setDatabaseName(String databaseName)
Database name for the endpoint.
databaseName
- Database name for the endpoint.public String getDatabaseName()
Database name for the endpoint.
public PostgreSQLSettings withDatabaseName(String databaseName)
Database name for the endpoint.
databaseName
- Database name for the endpoint.public void setDdlArtifactsSchema(String ddlArtifactsSchema)
The schema in which the operational DDL database artifacts are created.
Example: ddlArtifactsSchema=xyzddlschema;
ddlArtifactsSchema
- The schema in which the operational DDL database artifacts are created.
Example: ddlArtifactsSchema=xyzddlschema;
public String getDdlArtifactsSchema()
The schema in which the operational DDL database artifacts are created.
Example: ddlArtifactsSchema=xyzddlschema;
Example: ddlArtifactsSchema=xyzddlschema;
public PostgreSQLSettings withDdlArtifactsSchema(String ddlArtifactsSchema)
The schema in which the operational DDL database artifacts are created.
Example: ddlArtifactsSchema=xyzddlschema;
ddlArtifactsSchema
- The schema in which the operational DDL database artifacts are created.
Example: ddlArtifactsSchema=xyzddlschema;
public void setExecuteTimeout(Integer executeTimeout)
Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
Example: executeTimeout=100;
executeTimeout
- Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60
seconds.
Example: executeTimeout=100;
public Integer getExecuteTimeout()
Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
Example: executeTimeout=100;
Example: executeTimeout=100;
public PostgreSQLSettings withExecuteTimeout(Integer executeTimeout)
Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
Example: executeTimeout=100;
executeTimeout
- Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60
seconds.
Example: executeTimeout=100;
public void setFailTasksOnLobTruncation(Boolean failTasksOnLobTruncation)
When set to true
, this value causes a task to fail if the actual size of a LOB column is greater
than the specified LobMaxSize
.
If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
failTasksOnLobTruncation
- When set to true
, this value causes a task to fail if the actual size of a LOB column is
greater than the specified LobMaxSize
.
If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
public Boolean getFailTasksOnLobTruncation()
When set to true
, this value causes a task to fail if the actual size of a LOB column is greater
than the specified LobMaxSize
.
If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
true
, this value causes a task to fail if the actual size of a LOB column is
greater than the specified LobMaxSize
.
If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
public PostgreSQLSettings withFailTasksOnLobTruncation(Boolean failTasksOnLobTruncation)
When set to true
, this value causes a task to fail if the actual size of a LOB column is greater
than the specified LobMaxSize
.
If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
failTasksOnLobTruncation
- When set to true
, this value causes a task to fail if the actual size of a LOB column is
greater than the specified LobMaxSize
.
If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
public Boolean isFailTasksOnLobTruncation()
When set to true
, this value causes a task to fail if the actual size of a LOB column is greater
than the specified LobMaxSize
.
If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
true
, this value causes a task to fail if the actual size of a LOB column is
greater than the specified LobMaxSize
.
If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
public void setHeartbeatEnable(Boolean 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.
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.public Boolean getHeartbeatEnable()
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.
restart_lsn
moving and prevents storage full scenarios.public PostgreSQLSettings withHeartbeatEnable(Boolean 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.
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.public Boolean isHeartbeatEnable()
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.
restart_lsn
moving and prevents storage full scenarios.public void setHeartbeatSchema(String heartbeatSchema)
Sets the schema in which the heartbeat artifacts are created.
heartbeatSchema
- Sets the schema in which the heartbeat artifacts are created.public String getHeartbeatSchema()
Sets the schema in which the heartbeat artifacts are created.
public PostgreSQLSettings withHeartbeatSchema(String heartbeatSchema)
Sets the schema in which the heartbeat artifacts are created.
heartbeatSchema
- Sets the schema in which the heartbeat artifacts are created.public void setHeartbeatFrequency(Integer heartbeatFrequency)
Sets the WAL heartbeat frequency (in minutes).
heartbeatFrequency
- Sets the WAL heartbeat frequency (in minutes).public Integer getHeartbeatFrequency()
Sets the WAL heartbeat frequency (in minutes).
public PostgreSQLSettings withHeartbeatFrequency(Integer heartbeatFrequency)
Sets the WAL heartbeat frequency (in minutes).
heartbeatFrequency
- Sets the WAL heartbeat frequency (in minutes).public void setPassword(String password)
Endpoint connection password.
password
- Endpoint connection password.public String getPassword()
Endpoint connection password.
public PostgreSQLSettings withPassword(String password)
Endpoint connection password.
password
- Endpoint connection password.public void setPort(Integer port)
Endpoint TCP port. The default is 5432.
port
- Endpoint TCP port. The default is 5432.public Integer getPort()
Endpoint TCP port. The default is 5432.
public PostgreSQLSettings withPort(Integer port)
Endpoint TCP port. The default is 5432.
port
- Endpoint TCP port. The default is 5432.public void setServerName(String 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.
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.
public String getServerName()
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.
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.
public PostgreSQLSettings withServerName(String 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.
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.
public void setUsername(String username)
Endpoint connection user name.
username
- Endpoint connection user name.public String getUsername()
Endpoint connection user name.
public PostgreSQLSettings withUsername(String username)
Endpoint connection user name.
username
- Endpoint connection user name.public void setSlotName(String 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 of
CdcStartPosition
. If the specified slot doesn't exist or the task doesn't have a valid
CdcStartPosition
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 using CdcStartPosition
, see CreateReplicationTask, StartReplicationTask, and ModifyReplicationTask.
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
of CdcStartPosition
. If the specified slot doesn't exist or the task doesn't have a valid
CdcStartPosition
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 using CdcStartPosition
, see CreateReplicationTask, StartReplicationTask, and ModifyReplicationTask.
public String getSlotName()
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 of
CdcStartPosition
. If the specified slot doesn't exist or the task doesn't have a valid
CdcStartPosition
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 using CdcStartPosition
, see CreateReplicationTask, StartReplicationTask, and ModifyReplicationTask.
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 of CdcStartPosition
. If the specified slot doesn't exist or the task doesn't have a
valid CdcStartPosition
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 using CdcStartPosition
, see CreateReplicationTask, StartReplicationTask, and ModifyReplicationTask.
public PostgreSQLSettings withSlotName(String 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 of
CdcStartPosition
. If the specified slot doesn't exist or the task doesn't have a valid
CdcStartPosition
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 using CdcStartPosition
, see CreateReplicationTask, StartReplicationTask, and ModifyReplicationTask.
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
of CdcStartPosition
. If the specified slot doesn't exist or the task doesn't have a valid
CdcStartPosition
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 using CdcStartPosition
, see CreateReplicationTask, StartReplicationTask, and ModifyReplicationTask.
public void setPluginName(String pluginName)
Specifies the plugin to use to create a replication slot.
pluginName
- Specifies the plugin to use to create a replication slot.PluginNameValue
public String getPluginName()
Specifies the plugin to use to create a replication slot.
PluginNameValue
public PostgreSQLSettings withPluginName(String pluginName)
Specifies the plugin to use to create a replication slot.
pluginName
- Specifies the plugin to use to create a replication slot.PluginNameValue
public PostgreSQLSettings withPluginName(PluginNameValue pluginName)
Specifies the plugin to use to create a replication slot.
pluginName
- Specifies the plugin to use to create a replication slot.PluginNameValue
public void setSecretsManagerAccessRoleArn(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 in SecretsManagerSecret
. The role must allow the
iam: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 for UserName
,
Password
, ServerName
, and Port
. You can't specify both. For more
information on creating this SecretsManagerSecret
and the SecretsManagerAccessRoleArn
and SecretsManagerSecretId
required to access it, see Using
secrets to access Database Migration Service resources in the Database Migration Service User Guide.
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 the
iam: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 for
UserName
, Password
, ServerName
, and Port
. You can't
specify both. For more information on creating this SecretsManagerSecret
and the
SecretsManagerAccessRoleArn
and SecretsManagerSecretId
required to access it,
see Using secrets to access Database Migration Service resources in the Database Migration Service
User Guide.
public String getSecretsManagerAccessRoleArn()
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 the
iam: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 for UserName
,
Password
, ServerName
, and Port
. You can't specify both. For more
information on creating this SecretsManagerSecret
and the SecretsManagerAccessRoleArn
and SecretsManagerSecretId
required to access it, see Using
secrets to access Database Migration Service resources in the Database Migration Service User Guide.
SecretsManagerSecret
. The role must allow
the iam: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 for
UserName
, Password
, ServerName
, and Port
. You can't
specify both. For more information on creating this SecretsManagerSecret
and the
SecretsManagerAccessRoleArn
and SecretsManagerSecretId
required to access it,
see Using secrets to access Database Migration Service resources in the Database Migration Service
User Guide.
public PostgreSQLSettings withSecretsManagerAccessRoleArn(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 in SecretsManagerSecret
. The role must allow the
iam: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 for UserName
,
Password
, ServerName
, and Port
. You can't specify both. For more
information on creating this SecretsManagerSecret
and the SecretsManagerAccessRoleArn
and SecretsManagerSecretId
required to access it, see Using
secrets to access Database Migration Service resources in the Database Migration Service User Guide.
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 the
iam: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 for
UserName
, Password
, ServerName
, and Port
. You can't
specify both. For more information on creating this SecretsManagerSecret
and the
SecretsManagerAccessRoleArn
and SecretsManagerSecretId
required to access it,
see Using secrets to access Database Migration Service resources in the Database Migration Service
User Guide.
public void setSecretsManagerSecretId(String secretsManagerSecretId)
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the PostgreSQL
endpoint connection details.
secretsManagerSecretId
- The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the
PostgreSQL endpoint connection details.public String getSecretsManagerSecretId()
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the PostgreSQL
endpoint connection details.
SecretsManagerSecret
that contains the
PostgreSQL endpoint connection details.public PostgreSQLSettings withSecretsManagerSecretId(String secretsManagerSecretId)
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the PostgreSQL
endpoint connection details.
secretsManagerSecretId
- The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the
PostgreSQL endpoint connection details.public void setTrimSpaceInChar(Boolean trimSpaceInChar)
Use the TrimSpaceInChar
source endpoint setting to trim data on CHAR and NCHAR data types during
migration. The default value is true
.
trimSpaceInChar
- Use the TrimSpaceInChar
source endpoint setting to trim data on CHAR and NCHAR data types
during migration. The default value is true
.public Boolean getTrimSpaceInChar()
Use the TrimSpaceInChar
source endpoint setting to trim data on CHAR and NCHAR data types during
migration. The default value is true
.
TrimSpaceInChar
source endpoint setting to trim data on CHAR and NCHAR data types
during migration. The default value is true
.public PostgreSQLSettings withTrimSpaceInChar(Boolean trimSpaceInChar)
Use the TrimSpaceInChar
source endpoint setting to trim data on CHAR and NCHAR data types during
migration. The default value is true
.
trimSpaceInChar
- Use the TrimSpaceInChar
source endpoint setting to trim data on CHAR and NCHAR data types
during migration. The default value is true
.public Boolean isTrimSpaceInChar()
Use the TrimSpaceInChar
source endpoint setting to trim data on CHAR and NCHAR data types during
migration. The default value is true
.
TrimSpaceInChar
source endpoint setting to trim data on CHAR and NCHAR data types
during migration. The default value is true
.public void setMapBooleanAsBoolean(Boolean 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.
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.public Boolean getMapBooleanAsBoolean()
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.
varchar(5)
. You must set this setting on both the source and target endpoints for it to
take effect.public PostgreSQLSettings withMapBooleanAsBoolean(Boolean 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.
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.public Boolean isMapBooleanAsBoolean()
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.
varchar(5)
. You must set this setting on both the source and target endpoints for it to
take effect.public void setMapJsonbAsClob(Boolean mapJsonbAsClob)
When true, DMS migrates JSONB values as CLOB.
mapJsonbAsClob
- When true, DMS migrates JSONB values as CLOB.public Boolean getMapJsonbAsClob()
When true, DMS migrates JSONB values as CLOB.
public PostgreSQLSettings withMapJsonbAsClob(Boolean mapJsonbAsClob)
When true, DMS migrates JSONB values as CLOB.
mapJsonbAsClob
- When true, DMS migrates JSONB values as CLOB.public Boolean isMapJsonbAsClob()
When true, DMS migrates JSONB values as CLOB.
public void setMapLongVarcharAs(String mapLongVarcharAs)
When true, DMS migrates LONG values as VARCHAR.
mapLongVarcharAs
- When true, DMS migrates LONG values as VARCHAR.LongVarcharMappingType
public String getMapLongVarcharAs()
When true, DMS migrates LONG values as VARCHAR.
LongVarcharMappingType
public PostgreSQLSettings withMapLongVarcharAs(String mapLongVarcharAs)
When true, DMS migrates LONG values as VARCHAR.
mapLongVarcharAs
- When true, DMS migrates LONG values as VARCHAR.LongVarcharMappingType
public PostgreSQLSettings withMapLongVarcharAs(LongVarcharMappingType mapLongVarcharAs)
When true, DMS migrates LONG values as VARCHAR.
mapLongVarcharAs
- When true, DMS migrates LONG values as VARCHAR.LongVarcharMappingType
public void setDatabaseMode(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
- Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that
require some additional configuration, such as Babelfish endpoints.DatabaseMode
public String getDatabaseMode()
Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
DatabaseMode
public PostgreSQLSettings withDatabaseMode(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
- Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that
require some additional configuration, such as Babelfish endpoints.DatabaseMode
public PostgreSQLSettings withDatabaseMode(DatabaseMode databaseMode)
Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
databaseMode
- Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that
require some additional configuration, such as Babelfish endpoints.DatabaseMode
public void setBabelfishDatabaseName(String babelfishDatabaseName)
The Babelfish for Aurora PostgreSQL database name for the endpoint.
babelfishDatabaseName
- The Babelfish for Aurora PostgreSQL database name for the endpoint.public String getBabelfishDatabaseName()
The Babelfish for Aurora PostgreSQL database name for the endpoint.
public PostgreSQLSettings withBabelfishDatabaseName(String babelfishDatabaseName)
The Babelfish for Aurora PostgreSQL database name for the endpoint.
babelfishDatabaseName
- The Babelfish for Aurora PostgreSQL database name for the endpoint.public String toString()
toString
in class Object
Object.toString()
public PostgreSQLSettings clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.