/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.databasemigrationservice.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
* <p>
* Provides information that defines a PostgreSQL endpoint.
* </p>
*
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/PostgreSQLSettings" target="_top">AWS API
* Documentation</a>
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PostgreSQLSettings implements Serializable, Cloneable, StructuredPojo {
/**
* <p>
* 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.
* </p>
* <p>
* Example: <code>afterConnectScript=SET session_replication_role='replica'</code>
* </p>
*/
private String afterConnectScript;
/**
* <p>
* To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts. You can
* later remove these artifacts.
* </p>
* <p>
* If this value is set to <code>N</code>, you don't have to create tables or triggers on the source database.
* </p>
*/
private Boolean captureDdls;
/**
* <p>
* Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
* </p>
* <p>
* Example: <code>maxFileSize=512</code>
* </p>
*/
private Integer maxFileSize;
/**
* <p>
* Database name for the endpoint.
* </p>
*/
private String databaseName;
/**
* <p>
* The schema in which the operational DDL database artifacts are created.
* </p>
* <p>
* Example: <code>ddlArtifactsSchema=xyzddlschema;</code>
* </p>
*/
private String ddlArtifactsSchema;
/**
* <p>
* Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
* </p>
* <p>
* Example: <code>executeTimeout=100;</code>
* </p>
*/
private Integer executeTimeout;
/**
* <p>
* When set to <code>true</code>, this value causes a task to fail if the actual size of a LOB column is greater
* than the specified <code>LobMaxSize</code>.
* </p>
* <p>
* If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB
* data.
* </p>
*/
private Boolean failTasksOnLobTruncation;
/**
* <p>
* 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 <code>restart_lsn</code> moving and prevents storage full scenarios.
* </p>
*/
private Boolean heartbeatEnable;
/**
* <p>
* Sets the schema in which the heartbeat artifacts are created.
* </p>
*/
private String heartbeatSchema;
/**
* <p>
* Sets the WAL heartbeat frequency (in minutes).
* </p>
*/
private Integer heartbeatFrequency;
/**
* <p>
* Endpoint connection password.
* </p>
*/
private String password;
/**
* <p>
* Endpoint TCP port. The default is 5432.
* </p>
*/
private Integer port;
/**
* <p>
* The host name of the endpoint database.
* </p>
* <p>
* For an Amazon RDS PostgreSQL instance, this is the output of <a
* href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html"
* >DescribeDBInstances</a>, in the
* <code> <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html">Endpoint</a>.Address</code>
* field.
* </p>
* <p>
* For an Aurora PostgreSQL instance, this is the output of <a
* href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html"
* >DescribeDBClusters</a>, in the <code>Endpoint</code> field.
* </p>
*/
private String serverName;
/**
* <p>
* Endpoint connection user name.
* </p>
*/
private String username;
/**
* <p>
* Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the
* PostgreSQL source instance.
* </p>
* <p>
* When used with the <code>CdcStartPosition</code> 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
* <code>CdcStartPosition</code>. If the specified slot doesn't exist or the task doesn't have a valid
* <code>CdcStartPosition</code> setting, DMS raises an error.
* </p>
* <p>
* For more information about setting the <code>CdcStartPosition</code> request parameter, see <a
* href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native"
* >Determining a CDC native start point</a> in the <i>Database Migration Service User Guide</i>. For more
* information about using <code>CdcStartPosition</code>, see <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html"
* >CreateReplicationTask</a>, <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html"
* >StartReplicationTask</a>, and <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html"
* >ModifyReplicationTask</a>.
* </p>
*/
private String slotName;
/**
* <p>
* Specifies the plugin to use to create a replication slot.
* </p>
*/
private String pluginName;
/**
* <p>
* 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 <code>SecretsManagerSecret</code>. The role must allow the
* <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services
* Secrets Manager secret that allows access to the PostgreSQL endpoint.
* </p>
* <note>
* <p>
* You can specify one of two sets of values for these permissions. You can specify the values for this setting and
* <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>,
* <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more
* information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code>
* and <code>SecretsManagerSecretId</code> required to access it, see <a
* href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using
* secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.
* </p>
* </note>
*/
private String secretsManagerAccessRoleArn;
/**
* <p>
* The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the PostgreSQL
* endpoint connection details.
* </p>
*/
private String secretsManagerSecretId;
/**
* <p>
* Use the <code>TrimSpaceInChar</code> source endpoint setting to trim data on CHAR and NCHAR data types during
* migration. The default value is <code>true</code>.
* </p>
*/
private Boolean trimSpaceInChar;
/**
* <p>
* When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans as
* <code>varchar(5)</code>.
* </p>
*/
private Boolean mapBooleanAsBoolean;
/**
* <p>
* When true, DMS migrates JSONB values as CLOB.
* </p>
*/
private Boolean mapJsonbAsClob;
/**
* <p>
* When true, DMS migrates LONG values as VARCHAR.
* </p>
*/
private String mapLongVarcharAs;
/**
* <p>
* Specifies whether to use default or custom replication behavior for PostgreSQL-compatible endpoints. You can use
* this setting to specify replication behavior for endpoints that require additional configuration, such as
* Babelfish endpoints.
* </p>
*/
private String databaseMode;
/**
* <p>
* The Babelfish for Aurora PostgreSQL database name for the endpoint.
* </p>
*/
private String babelfishDatabaseName;
/**
* <p>
* 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.
* </p>
* <p>
* Example: <code>afterConnectScript=SET session_replication_role='replica'</code>
* </p>
*
* @param 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.</p>
* <p>
* Example: <code>afterConnectScript=SET session_replication_role='replica'</code>
*/
public void setAfterConnectScript(String afterConnectScript) {
this.afterConnectScript = afterConnectScript;
}
/**
* <p>
* 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.
* </p>
* <p>
* Example: <code>afterConnectScript=SET session_replication_role='replica'</code>
* </p>
*
* @return 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.</p>
* <p>
* Example: <code>afterConnectScript=SET session_replication_role='replica'</code>
*/
public String getAfterConnectScript() {
return this.afterConnectScript;
}
/**
* <p>
* 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.
* </p>
* <p>
* Example: <code>afterConnectScript=SET session_replication_role='replica'</code>
* </p>
*
* @param 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.</p>
* <p>
* Example: <code>afterConnectScript=SET session_replication_role='replica'</code>
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withAfterConnectScript(String afterConnectScript) {
setAfterConnectScript(afterConnectScript);
return this;
}
/**
* <p>
* To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts. You can
* later remove these artifacts.
* </p>
* <p>
* If this value is set to <code>N</code>, you don't have to create tables or triggers on the source database.
* </p>
*
* @param captureDdls
* To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts. You
* can later remove these artifacts.</p>
* <p>
* If this value is set to <code>N</code>, you don't have to create tables or triggers on the source
* database.
*/
public void setCaptureDdls(Boolean captureDdls) {
this.captureDdls = captureDdls;
}
/**
* <p>
* To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts. You can
* later remove these artifacts.
* </p>
* <p>
* If this value is set to <code>N</code>, you don't have to create tables or triggers on the source database.
* </p>
*
* @return To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts. You
* can later remove these artifacts.</p>
* <p>
* If this value is set to <code>N</code>, you don't have to create tables or triggers on the source
* database.
*/
public Boolean getCaptureDdls() {
return this.captureDdls;
}
/**
* <p>
* To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts. You can
* later remove these artifacts.
* </p>
* <p>
* If this value is set to <code>N</code>, you don't have to create tables or triggers on the source database.
* </p>
*
* @param captureDdls
* To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts. You
* can later remove these artifacts.</p>
* <p>
* If this value is set to <code>N</code>, you don't have to create tables or triggers on the source
* database.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withCaptureDdls(Boolean captureDdls) {
setCaptureDdls(captureDdls);
return this;
}
/**
* <p>
* To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts. You can
* later remove these artifacts.
* </p>
* <p>
* If this value is set to <code>N</code>, you don't have to create tables or triggers on the source database.
* </p>
*
* @return To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts. You
* can later remove these artifacts.</p>
* <p>
* If this value is set to <code>N</code>, you don't have to create tables or triggers on the source
* database.
*/
public Boolean isCaptureDdls() {
return this.captureDdls;
}
/**
* <p>
* Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
* </p>
* <p>
* Example: <code>maxFileSize=512</code>
* </p>
*
* @param maxFileSize
* Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.</p>
* <p>
* Example: <code>maxFileSize=512</code>
*/
public void setMaxFileSize(Integer maxFileSize) {
this.maxFileSize = maxFileSize;
}
/**
* <p>
* Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
* </p>
* <p>
* Example: <code>maxFileSize=512</code>
* </p>
*
* @return Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.</p>
* <p>
* Example: <code>maxFileSize=512</code>
*/
public Integer getMaxFileSize() {
return this.maxFileSize;
}
/**
* <p>
* Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
* </p>
* <p>
* Example: <code>maxFileSize=512</code>
* </p>
*
* @param maxFileSize
* Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.</p>
* <p>
* Example: <code>maxFileSize=512</code>
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withMaxFileSize(Integer maxFileSize) {
setMaxFileSize(maxFileSize);
return this;
}
/**
* <p>
* Database name for the endpoint.
* </p>
*
* @param databaseName
* Database name for the endpoint.
*/
public void setDatabaseName(String databaseName) {
this.databaseName = databaseName;
}
/**
* <p>
* Database name for the endpoint.
* </p>
*
* @return Database name for the endpoint.
*/
public String getDatabaseName() {
return this.databaseName;
}
/**
* <p>
* Database name for the endpoint.
* </p>
*
* @param databaseName
* Database name for the endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withDatabaseName(String databaseName) {
setDatabaseName(databaseName);
return this;
}
/**
* <p>
* The schema in which the operational DDL database artifacts are created.
* </p>
* <p>
* Example: <code>ddlArtifactsSchema=xyzddlschema;</code>
* </p>
*
* @param ddlArtifactsSchema
* The schema in which the operational DDL database artifacts are created.</p>
* <p>
* Example: <code>ddlArtifactsSchema=xyzddlschema;</code>
*/
public void setDdlArtifactsSchema(String ddlArtifactsSchema) {
this.ddlArtifactsSchema = ddlArtifactsSchema;
}
/**
* <p>
* The schema in which the operational DDL database artifacts are created.
* </p>
* <p>
* Example: <code>ddlArtifactsSchema=xyzddlschema;</code>
* </p>
*
* @return The schema in which the operational DDL database artifacts are created.</p>
* <p>
* Example: <code>ddlArtifactsSchema=xyzddlschema;</code>
*/
public String getDdlArtifactsSchema() {
return this.ddlArtifactsSchema;
}
/**
* <p>
* The schema in which the operational DDL database artifacts are created.
* </p>
* <p>
* Example: <code>ddlArtifactsSchema=xyzddlschema;</code>
* </p>
*
* @param ddlArtifactsSchema
* The schema in which the operational DDL database artifacts are created.</p>
* <p>
* Example: <code>ddlArtifactsSchema=xyzddlschema;</code>
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withDdlArtifactsSchema(String ddlArtifactsSchema) {
setDdlArtifactsSchema(ddlArtifactsSchema);
return this;
}
/**
* <p>
* Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
* </p>
* <p>
* Example: <code>executeTimeout=100;</code>
* </p>
*
* @param executeTimeout
* Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60
* seconds.</p>
* <p>
* Example: <code>executeTimeout=100;</code>
*/
public void setExecuteTimeout(Integer executeTimeout) {
this.executeTimeout = executeTimeout;
}
/**
* <p>
* Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
* </p>
* <p>
* Example: <code>executeTimeout=100;</code>
* </p>
*
* @return Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60
* seconds.</p>
* <p>
* Example: <code>executeTimeout=100;</code>
*/
public Integer getExecuteTimeout() {
return this.executeTimeout;
}
/**
* <p>
* Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
* </p>
* <p>
* Example: <code>executeTimeout=100;</code>
* </p>
*
* @param executeTimeout
* Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60
* seconds.</p>
* <p>
* Example: <code>executeTimeout=100;</code>
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withExecuteTimeout(Integer executeTimeout) {
setExecuteTimeout(executeTimeout);
return this;
}
/**
* <p>
* When set to <code>true</code>, this value causes a task to fail if the actual size of a LOB column is greater
* than the specified <code>LobMaxSize</code>.
* </p>
* <p>
* If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB
* data.
* </p>
*
* @param failTasksOnLobTruncation
* When set to <code>true</code>, this value causes a task to fail if the actual size of a LOB column is
* greater than the specified <code>LobMaxSize</code>.</p>
* <p>
* 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 setFailTasksOnLobTruncation(Boolean failTasksOnLobTruncation) {
this.failTasksOnLobTruncation = failTasksOnLobTruncation;
}
/**
* <p>
* When set to <code>true</code>, this value causes a task to fail if the actual size of a LOB column is greater
* than the specified <code>LobMaxSize</code>.
* </p>
* <p>
* If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB
* data.
* </p>
*
* @return When set to <code>true</code>, this value causes a task to fail if the actual size of a LOB column is
* greater than the specified <code>LobMaxSize</code>.</p>
* <p>
* 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() {
return this.failTasksOnLobTruncation;
}
/**
* <p>
* When set to <code>true</code>, this value causes a task to fail if the actual size of a LOB column is greater
* than the specified <code>LobMaxSize</code>.
* </p>
* <p>
* If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB
* data.
* </p>
*
* @param failTasksOnLobTruncation
* When set to <code>true</code>, this value causes a task to fail if the actual size of a LOB column is
* greater than the specified <code>LobMaxSize</code>.</p>
* <p>
* If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating
* the LOB data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withFailTasksOnLobTruncation(Boolean failTasksOnLobTruncation) {
setFailTasksOnLobTruncation(failTasksOnLobTruncation);
return this;
}
/**
* <p>
* When set to <code>true</code>, this value causes a task to fail if the actual size of a LOB column is greater
* than the specified <code>LobMaxSize</code>.
* </p>
* <p>
* If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB
* data.
* </p>
*
* @return When set to <code>true</code>, this value causes a task to fail if the actual size of a LOB column is
* greater than the specified <code>LobMaxSize</code>.</p>
* <p>
* 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() {
return this.failTasksOnLobTruncation;
}
/**
* <p>
* 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 <code>restart_lsn</code> moving and prevents storage full scenarios.
* </p>
*
* @param 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 <code>restart_lsn</code> moving and prevents storage full scenarios.
*/
public void setHeartbeatEnable(Boolean heartbeatEnable) {
this.heartbeatEnable = heartbeatEnable;
}
/**
* <p>
* 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 <code>restart_lsn</code> moving and prevents storage full scenarios.
* </p>
*
* @return 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 <code>restart_lsn</code> moving and prevents storage full scenarios.
*/
public Boolean getHeartbeatEnable() {
return this.heartbeatEnable;
}
/**
* <p>
* 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 <code>restart_lsn</code> moving and prevents storage full scenarios.
* </p>
*
* @param 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 <code>restart_lsn</code> moving and prevents storage full scenarios.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withHeartbeatEnable(Boolean heartbeatEnable) {
setHeartbeatEnable(heartbeatEnable);
return this;
}
/**
* <p>
* 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 <code>restart_lsn</code> moving and prevents storage full scenarios.
* </p>
*
* @return 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 <code>restart_lsn</code> moving and prevents storage full scenarios.
*/
public Boolean isHeartbeatEnable() {
return this.heartbeatEnable;
}
/**
* <p>
* Sets the schema in which the heartbeat artifacts are created.
* </p>
*
* @param heartbeatSchema
* Sets the schema in which the heartbeat artifacts are created.
*/
public void setHeartbeatSchema(String heartbeatSchema) {
this.heartbeatSchema = heartbeatSchema;
}
/**
* <p>
* Sets the schema in which the heartbeat artifacts are created.
* </p>
*
* @return Sets the schema in which the heartbeat artifacts are created.
*/
public String getHeartbeatSchema() {
return this.heartbeatSchema;
}
/**
* <p>
* Sets the schema in which the heartbeat artifacts are created.
* </p>
*
* @param heartbeatSchema
* Sets the schema in which the heartbeat artifacts are created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withHeartbeatSchema(String heartbeatSchema) {
setHeartbeatSchema(heartbeatSchema);
return this;
}
/**
* <p>
* Sets the WAL heartbeat frequency (in minutes).
* </p>
*
* @param heartbeatFrequency
* Sets the WAL heartbeat frequency (in minutes).
*/
public void setHeartbeatFrequency(Integer heartbeatFrequency) {
this.heartbeatFrequency = heartbeatFrequency;
}
/**
* <p>
* Sets the WAL heartbeat frequency (in minutes).
* </p>
*
* @return Sets the WAL heartbeat frequency (in minutes).
*/
public Integer getHeartbeatFrequency() {
return this.heartbeatFrequency;
}
/**
* <p>
* Sets the WAL heartbeat frequency (in minutes).
* </p>
*
* @param heartbeatFrequency
* Sets the WAL heartbeat frequency (in minutes).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withHeartbeatFrequency(Integer heartbeatFrequency) {
setHeartbeatFrequency(heartbeatFrequency);
return this;
}
/**
* <p>
* Endpoint connection password.
* </p>
*
* @param password
* Endpoint connection password.
*/
public void setPassword(String password) {
this.password = password;
}
/**
* <p>
* Endpoint connection password.
* </p>
*
* @return Endpoint connection password.
*/
public String getPassword() {
return this.password;
}
/**
* <p>
* Endpoint connection password.
* </p>
*
* @param password
* Endpoint connection password.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withPassword(String password) {
setPassword(password);
return this;
}
/**
* <p>
* Endpoint TCP port. The default is 5432.
* </p>
*
* @param port
* Endpoint TCP port. The default is 5432.
*/
public void setPort(Integer port) {
this.port = port;
}
/**
* <p>
* Endpoint TCP port. The default is 5432.
* </p>
*
* @return Endpoint TCP port. The default is 5432.
*/
public Integer getPort() {
return this.port;
}
/**
* <p>
* Endpoint TCP port. The default is 5432.
* </p>
*
* @param port
* Endpoint TCP port. The default is 5432.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withPort(Integer port) {
setPort(port);
return this;
}
/**
* <p>
* The host name of the endpoint database.
* </p>
* <p>
* For an Amazon RDS PostgreSQL instance, this is the output of <a
* href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html"
* >DescribeDBInstances</a>, in the
* <code> <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html">Endpoint</a>.Address</code>
* field.
* </p>
* <p>
* For an Aurora PostgreSQL instance, this is the output of <a
* href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html"
* >DescribeDBClusters</a>, in the <code>Endpoint</code> field.
* </p>
*
* @param serverName
* The host name of the endpoint database. </p>
* <p>
* For an Amazon RDS PostgreSQL instance, this is the output of <a
* href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html"
* >DescribeDBInstances</a>, in the
* <code> <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html">Endpoint</a>.Address</code>
* field.
* </p>
* <p>
* For an Aurora PostgreSQL instance, this is the output of <a
* href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html"
* >DescribeDBClusters</a>, in the <code>Endpoint</code> field.
*/
public void setServerName(String serverName) {
this.serverName = serverName;
}
/**
* <p>
* The host name of the endpoint database.
* </p>
* <p>
* For an Amazon RDS PostgreSQL instance, this is the output of <a
* href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html"
* >DescribeDBInstances</a>, in the
* <code> <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html">Endpoint</a>.Address</code>
* field.
* </p>
* <p>
* For an Aurora PostgreSQL instance, this is the output of <a
* href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html"
* >DescribeDBClusters</a>, in the <code>Endpoint</code> field.
* </p>
*
* @return The host name of the endpoint database. </p>
* <p>
* For an Amazon RDS PostgreSQL instance, this is the output of <a
* href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html"
* >DescribeDBInstances</a>, in the
* <code> <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html">Endpoint</a>.Address</code>
* field.
* </p>
* <p>
* For an Aurora PostgreSQL instance, this is the output of <a
* href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html"
* >DescribeDBClusters</a>, in the <code>Endpoint</code> field.
*/
public String getServerName() {
return this.serverName;
}
/**
* <p>
* The host name of the endpoint database.
* </p>
* <p>
* For an Amazon RDS PostgreSQL instance, this is the output of <a
* href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html"
* >DescribeDBInstances</a>, in the
* <code> <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html">Endpoint</a>.Address</code>
* field.
* </p>
* <p>
* For an Aurora PostgreSQL instance, this is the output of <a
* href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html"
* >DescribeDBClusters</a>, in the <code>Endpoint</code> field.
* </p>
*
* @param serverName
* The host name of the endpoint database. </p>
* <p>
* For an Amazon RDS PostgreSQL instance, this is the output of <a
* href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html"
* >DescribeDBInstances</a>, in the
* <code> <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html">Endpoint</a>.Address</code>
* field.
* </p>
* <p>
* For an Aurora PostgreSQL instance, this is the output of <a
* href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html"
* >DescribeDBClusters</a>, in the <code>Endpoint</code> field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withServerName(String serverName) {
setServerName(serverName);
return this;
}
/**
* <p>
* Endpoint connection user name.
* </p>
*
* @param username
* Endpoint connection user name.
*/
public void setUsername(String username) {
this.username = username;
}
/**
* <p>
* Endpoint connection user name.
* </p>
*
* @return Endpoint connection user name.
*/
public String getUsername() {
return this.username;
}
/**
* <p>
* Endpoint connection user name.
* </p>
*
* @param username
* Endpoint connection user name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withUsername(String username) {
setUsername(username);
return this;
}
/**
* <p>
* Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the
* PostgreSQL source instance.
* </p>
* <p>
* When used with the <code>CdcStartPosition</code> 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
* <code>CdcStartPosition</code>. If the specified slot doesn't exist or the task doesn't have a valid
* <code>CdcStartPosition</code> setting, DMS raises an error.
* </p>
* <p>
* For more information about setting the <code>CdcStartPosition</code> request parameter, see <a
* href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native"
* >Determining a CDC native start point</a> in the <i>Database Migration Service User Guide</i>. For more
* information about using <code>CdcStartPosition</code>, see <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html"
* >CreateReplicationTask</a>, <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html"
* >StartReplicationTask</a>, and <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html"
* >ModifyReplicationTask</a>.
* </p>
*
* @param slotName
* Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the
* PostgreSQL source instance. </p>
* <p>
* When used with the <code>CdcStartPosition</code> 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 <code>CdcStartPosition</code>. If the specified slot doesn't exist or the task doesn't have a valid
* <code>CdcStartPosition</code> setting, DMS raises an error.
* </p>
* <p>
* For more information about setting the <code>CdcStartPosition</code> request parameter, see <a
* href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native"
* >Determining a CDC native start point</a> in the <i>Database Migration Service User Guide</i>. For more
* information about using <code>CdcStartPosition</code>, see <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html"
* >CreateReplicationTask</a>, <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html"
* >StartReplicationTask</a>, and <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html"
* >ModifyReplicationTask</a>.
*/
public void setSlotName(String slotName) {
this.slotName = slotName;
}
/**
* <p>
* Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the
* PostgreSQL source instance.
* </p>
* <p>
* When used with the <code>CdcStartPosition</code> 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
* <code>CdcStartPosition</code>. If the specified slot doesn't exist or the task doesn't have a valid
* <code>CdcStartPosition</code> setting, DMS raises an error.
* </p>
* <p>
* For more information about setting the <code>CdcStartPosition</code> request parameter, see <a
* href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native"
* >Determining a CDC native start point</a> in the <i>Database Migration Service User Guide</i>. For more
* information about using <code>CdcStartPosition</code>, see <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html"
* >CreateReplicationTask</a>, <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html"
* >StartReplicationTask</a>, and <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html"
* >ModifyReplicationTask</a>.
* </p>
*
* @return Sets the name of a previously created logical replication slot for a change data capture (CDC) load of
* the PostgreSQL source instance. </p>
* <p>
* When used with the <code>CdcStartPosition</code> 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 <code>CdcStartPosition</code>. If the specified slot doesn't exist or the task doesn't have a
* valid <code>CdcStartPosition</code> setting, DMS raises an error.
* </p>
* <p>
* For more information about setting the <code>CdcStartPosition</code> request parameter, see <a
* href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native"
* >Determining a CDC native start point</a> in the <i>Database Migration Service User Guide</i>. For more
* information about using <code>CdcStartPosition</code>, see <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html"
* >CreateReplicationTask</a>, <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html"
* >StartReplicationTask</a>, and <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html"
* >ModifyReplicationTask</a>.
*/
public String getSlotName() {
return this.slotName;
}
/**
* <p>
* Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the
* PostgreSQL source instance.
* </p>
* <p>
* When used with the <code>CdcStartPosition</code> 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
* <code>CdcStartPosition</code>. If the specified slot doesn't exist or the task doesn't have a valid
* <code>CdcStartPosition</code> setting, DMS raises an error.
* </p>
* <p>
* For more information about setting the <code>CdcStartPosition</code> request parameter, see <a
* href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native"
* >Determining a CDC native start point</a> in the <i>Database Migration Service User Guide</i>. For more
* information about using <code>CdcStartPosition</code>, see <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html"
* >CreateReplicationTask</a>, <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html"
* >StartReplicationTask</a>, and <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html"
* >ModifyReplicationTask</a>.
* </p>
*
* @param slotName
* Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the
* PostgreSQL source instance. </p>
* <p>
* When used with the <code>CdcStartPosition</code> 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 <code>CdcStartPosition</code>. If the specified slot doesn't exist or the task doesn't have a valid
* <code>CdcStartPosition</code> setting, DMS raises an error.
* </p>
* <p>
* For more information about setting the <code>CdcStartPosition</code> request parameter, see <a
* href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native"
* >Determining a CDC native start point</a> in the <i>Database Migration Service User Guide</i>. For more
* information about using <code>CdcStartPosition</code>, see <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html"
* >CreateReplicationTask</a>, <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html"
* >StartReplicationTask</a>, and <a
* href="https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html"
* >ModifyReplicationTask</a>.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withSlotName(String slotName) {
setSlotName(slotName);
return this;
}
/**
* <p>
* Specifies the plugin to use to create a replication slot.
* </p>
*
* @param pluginName
* Specifies the plugin to use to create a replication slot.
* @see PluginNameValue
*/
public void setPluginName(String pluginName) {
this.pluginName = pluginName;
}
/**
* <p>
* Specifies the plugin to use to create a replication slot.
* </p>
*
* @return Specifies the plugin to use to create a replication slot.
* @see PluginNameValue
*/
public String getPluginName() {
return this.pluginName;
}
/**
* <p>
* Specifies the plugin to use to create a replication slot.
* </p>
*
* @param pluginName
* Specifies the plugin to use to create a replication slot.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PluginNameValue
*/
public PostgreSQLSettings withPluginName(String pluginName) {
setPluginName(pluginName);
return this;
}
/**
* <p>
* Specifies the plugin to use to create a replication slot.
* </p>
*
* @param pluginName
* Specifies the plugin to use to create a replication slot.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PluginNameValue
*/
public PostgreSQLSettings withPluginName(PluginNameValue pluginName) {
this.pluginName = pluginName.toString();
return this;
}
/**
* <p>
* 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 <code>SecretsManagerSecret</code>. The role must allow the
* <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services
* Secrets Manager secret that allows access to the PostgreSQL endpoint.
* </p>
* <note>
* <p>
* You can specify one of two sets of values for these permissions. You can specify the values for this setting and
* <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>,
* <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more
* information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code>
* and <code>SecretsManagerSecretId</code> required to access it, see <a
* href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using
* secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.
* </p>
* </note>
*
* @param 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 <code>SecretsManagerSecret</code>. The role must allow the
* <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web
* Services Secrets Manager secret that allows access to the PostgreSQL endpoint.</p> <note>
* <p>
* You can specify one of two sets of values for these permissions. You can specify the values for this
* setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for
* <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't
* specify both. For more information on creating this <code>SecretsManagerSecret</code> and the
* <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it,
* see <a
* href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager"
* >Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service
* User Guide</i>.
* </p>
*/
public void setSecretsManagerAccessRoleArn(String secretsManagerAccessRoleArn) {
this.secretsManagerAccessRoleArn = secretsManagerAccessRoleArn;
}
/**
* <p>
* 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 <code>SecretsManagerSecret</code>. The role must allow the
* <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services
* Secrets Manager secret that allows access to the PostgreSQL endpoint.
* </p>
* <note>
* <p>
* You can specify one of two sets of values for these permissions. You can specify the values for this setting and
* <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>,
* <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more
* information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code>
* and <code>SecretsManagerSecretId</code> required to access it, see <a
* href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using
* secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.
* </p>
* </note>
*
* @return 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 <code>SecretsManagerSecret</code>. The role must allow
* the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web
* Services Secrets Manager secret that allows access to the PostgreSQL endpoint.</p> <note>
* <p>
* You can specify one of two sets of values for these permissions. You can specify the values for this
* setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for
* <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't
* specify both. For more information on creating this <code>SecretsManagerSecret</code> and the
* <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it,
* see <a
* href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager"
* >Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service
* User Guide</i>.
* </p>
*/
public String getSecretsManagerAccessRoleArn() {
return this.secretsManagerAccessRoleArn;
}
/**
* <p>
* 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 <code>SecretsManagerSecret</code>. The role must allow the
* <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services
* Secrets Manager secret that allows access to the PostgreSQL endpoint.
* </p>
* <note>
* <p>
* You can specify one of two sets of values for these permissions. You can specify the values for this setting and
* <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>,
* <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more
* information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code>
* and <code>SecretsManagerSecretId</code> required to access it, see <a
* href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using
* secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.
* </p>
* </note>
*
* @param 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 <code>SecretsManagerSecret</code>. The role must allow the
* <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web
* Services Secrets Manager secret that allows access to the PostgreSQL endpoint.</p> <note>
* <p>
* You can specify one of two sets of values for these permissions. You can specify the values for this
* setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for
* <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't
* specify both. For more information on creating this <code>SecretsManagerSecret</code> and the
* <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it,
* see <a
* href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager"
* >Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service
* User Guide</i>.
* </p>
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withSecretsManagerAccessRoleArn(String secretsManagerAccessRoleArn) {
setSecretsManagerAccessRoleArn(secretsManagerAccessRoleArn);
return this;
}
/**
* <p>
* The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the PostgreSQL
* endpoint connection details.
* </p>
*
* @param secretsManagerSecretId
* The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the
* PostgreSQL endpoint connection details.
*/
public void setSecretsManagerSecretId(String secretsManagerSecretId) {
this.secretsManagerSecretId = secretsManagerSecretId;
}
/**
* <p>
* The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the PostgreSQL
* endpoint connection details.
* </p>
*
* @return The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the
* PostgreSQL endpoint connection details.
*/
public String getSecretsManagerSecretId() {
return this.secretsManagerSecretId;
}
/**
* <p>
* The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the PostgreSQL
* endpoint connection details.
* </p>
*
* @param secretsManagerSecretId
* The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the
* PostgreSQL endpoint connection details.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withSecretsManagerSecretId(String secretsManagerSecretId) {
setSecretsManagerSecretId(secretsManagerSecretId);
return this;
}
/**
* <p>
* Use the <code>TrimSpaceInChar</code> source endpoint setting to trim data on CHAR and NCHAR data types during
* migration. The default value is <code>true</code>.
* </p>
*
* @param trimSpaceInChar
* Use the <code>TrimSpaceInChar</code> source endpoint setting to trim data on CHAR and NCHAR data types
* during migration. The default value is <code>true</code>.
*/
public void setTrimSpaceInChar(Boolean trimSpaceInChar) {
this.trimSpaceInChar = trimSpaceInChar;
}
/**
* <p>
* Use the <code>TrimSpaceInChar</code> source endpoint setting to trim data on CHAR and NCHAR data types during
* migration. The default value is <code>true</code>.
* </p>
*
* @return Use the <code>TrimSpaceInChar</code> source endpoint setting to trim data on CHAR and NCHAR data types
* during migration. The default value is <code>true</code>.
*/
public Boolean getTrimSpaceInChar() {
return this.trimSpaceInChar;
}
/**
* <p>
* Use the <code>TrimSpaceInChar</code> source endpoint setting to trim data on CHAR and NCHAR data types during
* migration. The default value is <code>true</code>.
* </p>
*
* @param trimSpaceInChar
* Use the <code>TrimSpaceInChar</code> source endpoint setting to trim data on CHAR and NCHAR data types
* during migration. The default value is <code>true</code>.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withTrimSpaceInChar(Boolean trimSpaceInChar) {
setTrimSpaceInChar(trimSpaceInChar);
return this;
}
/**
* <p>
* Use the <code>TrimSpaceInChar</code> source endpoint setting to trim data on CHAR and NCHAR data types during
* migration. The default value is <code>true</code>.
* </p>
*
* @return Use the <code>TrimSpaceInChar</code> source endpoint setting to trim data on CHAR and NCHAR data types
* during migration. The default value is <code>true</code>.
*/
public Boolean isTrimSpaceInChar() {
return this.trimSpaceInChar;
}
/**
* <p>
* When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans as
* <code>varchar(5)</code>.
* </p>
*
* @param mapBooleanAsBoolean
* When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans
* as <code>varchar(5)</code>.
*/
public void setMapBooleanAsBoolean(Boolean mapBooleanAsBoolean) {
this.mapBooleanAsBoolean = mapBooleanAsBoolean;
}
/**
* <p>
* When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans as
* <code>varchar(5)</code>.
* </p>
*
* @return When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans
* as <code>varchar(5)</code>.
*/
public Boolean getMapBooleanAsBoolean() {
return this.mapBooleanAsBoolean;
}
/**
* <p>
* When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans as
* <code>varchar(5)</code>.
* </p>
*
* @param mapBooleanAsBoolean
* When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans
* as <code>varchar(5)</code>.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withMapBooleanAsBoolean(Boolean mapBooleanAsBoolean) {
setMapBooleanAsBoolean(mapBooleanAsBoolean);
return this;
}
/**
* <p>
* When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans as
* <code>varchar(5)</code>.
* </p>
*
* @return When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans
* as <code>varchar(5)</code>.
*/
public Boolean isMapBooleanAsBoolean() {
return this.mapBooleanAsBoolean;
}
/**
* <p>
* When true, DMS migrates JSONB values as CLOB.
* </p>
*
* @param mapJsonbAsClob
* When true, DMS migrates JSONB values as CLOB.
*/
public void setMapJsonbAsClob(Boolean mapJsonbAsClob) {
this.mapJsonbAsClob = mapJsonbAsClob;
}
/**
* <p>
* When true, DMS migrates JSONB values as CLOB.
* </p>
*
* @return When true, DMS migrates JSONB values as CLOB.
*/
public Boolean getMapJsonbAsClob() {
return this.mapJsonbAsClob;
}
/**
* <p>
* When true, DMS migrates JSONB values as CLOB.
* </p>
*
* @param mapJsonbAsClob
* When true, DMS migrates JSONB values as CLOB.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withMapJsonbAsClob(Boolean mapJsonbAsClob) {
setMapJsonbAsClob(mapJsonbAsClob);
return this;
}
/**
* <p>
* When true, DMS migrates JSONB values as CLOB.
* </p>
*
* @return When true, DMS migrates JSONB values as CLOB.
*/
public Boolean isMapJsonbAsClob() {
return this.mapJsonbAsClob;
}
/**
* <p>
* When true, DMS migrates LONG values as VARCHAR.
* </p>
*
* @param mapLongVarcharAs
* When true, DMS migrates LONG values as VARCHAR.
* @see LongVarcharMappingType
*/
public void setMapLongVarcharAs(String mapLongVarcharAs) {
this.mapLongVarcharAs = mapLongVarcharAs;
}
/**
* <p>
* When true, DMS migrates LONG values as VARCHAR.
* </p>
*
* @return When true, DMS migrates LONG values as VARCHAR.
* @see LongVarcharMappingType
*/
public String getMapLongVarcharAs() {
return this.mapLongVarcharAs;
}
/**
* <p>
* When true, DMS migrates LONG values as VARCHAR.
* </p>
*
* @param mapLongVarcharAs
* When true, DMS migrates LONG values as VARCHAR.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LongVarcharMappingType
*/
public PostgreSQLSettings withMapLongVarcharAs(String mapLongVarcharAs) {
setMapLongVarcharAs(mapLongVarcharAs);
return this;
}
/**
* <p>
* When true, DMS migrates LONG values as VARCHAR.
* </p>
*
* @param mapLongVarcharAs
* When true, DMS migrates LONG values as VARCHAR.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LongVarcharMappingType
*/
public PostgreSQLSettings withMapLongVarcharAs(LongVarcharMappingType mapLongVarcharAs) {
this.mapLongVarcharAs = mapLongVarcharAs.toString();
return this;
}
/**
* <p>
* Specifies whether to use default or custom replication behavior for PostgreSQL-compatible endpoints. You can use
* this setting to specify replication behavior for endpoints that require additional configuration, such as
* Babelfish endpoints.
* </p>
*
* @param databaseMode
* Specifies whether to use default or custom replication behavior for PostgreSQL-compatible endpoints. You
* can use this setting to specify replication behavior for endpoints that require additional configuration,
* such as Babelfish endpoints.
* @see DatabaseMode
*/
public void setDatabaseMode(String databaseMode) {
this.databaseMode = databaseMode;
}
/**
* <p>
* Specifies whether to use default or custom replication behavior for PostgreSQL-compatible endpoints. You can use
* this setting to specify replication behavior for endpoints that require additional configuration, such as
* Babelfish endpoints.
* </p>
*
* @return Specifies whether to use default or custom replication behavior for PostgreSQL-compatible endpoints. You
* can use this setting to specify replication behavior for endpoints that require additional configuration,
* such as Babelfish endpoints.
* @see DatabaseMode
*/
public String getDatabaseMode() {
return this.databaseMode;
}
/**
* <p>
* Specifies whether to use default or custom replication behavior for PostgreSQL-compatible endpoints. You can use
* this setting to specify replication behavior for endpoints that require additional configuration, such as
* Babelfish endpoints.
* </p>
*
* @param databaseMode
* Specifies whether to use default or custom replication behavior for PostgreSQL-compatible endpoints. You
* can use this setting to specify replication behavior for endpoints that require additional configuration,
* such as Babelfish endpoints.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DatabaseMode
*/
public PostgreSQLSettings withDatabaseMode(String databaseMode) {
setDatabaseMode(databaseMode);
return this;
}
/**
* <p>
* Specifies whether to use default or custom replication behavior for PostgreSQL-compatible endpoints. You can use
* this setting to specify replication behavior for endpoints that require additional configuration, such as
* Babelfish endpoints.
* </p>
*
* @param databaseMode
* Specifies whether to use default or custom replication behavior for PostgreSQL-compatible endpoints. You
* can use this setting to specify replication behavior for endpoints that require additional configuration,
* such as Babelfish endpoints.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DatabaseMode
*/
public PostgreSQLSettings withDatabaseMode(DatabaseMode databaseMode) {
this.databaseMode = databaseMode.toString();
return this;
}
/**
* <p>
* The Babelfish for Aurora PostgreSQL database name for the endpoint.
* </p>
*
* @param babelfishDatabaseName
* The Babelfish for Aurora PostgreSQL database name for the endpoint.
*/
public void setBabelfishDatabaseName(String babelfishDatabaseName) {
this.babelfishDatabaseName = babelfishDatabaseName;
}
/**
* <p>
* The Babelfish for Aurora PostgreSQL database name for the endpoint.
* </p>
*
* @return The Babelfish for Aurora PostgreSQL database name for the endpoint.
*/
public String getBabelfishDatabaseName() {
return this.babelfishDatabaseName;
}
/**
* <p>
* The Babelfish for Aurora PostgreSQL database name for the endpoint.
* </p>
*
* @param babelfishDatabaseName
* The Babelfish for Aurora PostgreSQL database name for the endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostgreSQLSettings withBabelfishDatabaseName(String babelfishDatabaseName) {
setBabelfishDatabaseName(babelfishDatabaseName);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getAfterConnectScript() != null)
sb.append("AfterConnectScript: ").append(getAfterConnectScript()).append(",");
if (getCaptureDdls() != null)
sb.append("CaptureDdls: ").append(getCaptureDdls()).append(",");
if (getMaxFileSize() != null)
sb.append("MaxFileSize: ").append(getMaxFileSize()).append(",");
if (getDatabaseName() != null)
sb.append("DatabaseName: ").append(getDatabaseName()).append(",");
if (getDdlArtifactsSchema() != null)
sb.append("DdlArtifactsSchema: ").append(getDdlArtifactsSchema()).append(",");
if (getExecuteTimeout() != null)
sb.append("ExecuteTimeout: ").append(getExecuteTimeout()).append(",");
if (getFailTasksOnLobTruncation() != null)
sb.append("FailTasksOnLobTruncation: ").append(getFailTasksOnLobTruncation()).append(",");
if (getHeartbeatEnable() != null)
sb.append("HeartbeatEnable: ").append(getHeartbeatEnable()).append(",");
if (getHeartbeatSchema() != null)
sb.append("HeartbeatSchema: ").append(getHeartbeatSchema()).append(",");
if (getHeartbeatFrequency() != null)
sb.append("HeartbeatFrequency: ").append(getHeartbeatFrequency()).append(",");
if (getPassword() != null)
sb.append("Password: ").append("***Sensitive Data Redacted***").append(",");
if (getPort() != null)
sb.append("Port: ").append(getPort()).append(",");
if (getServerName() != null)
sb.append("ServerName: ").append(getServerName()).append(",");
if (getUsername() != null)
sb.append("Username: ").append(getUsername()).append(",");
if (getSlotName() != null)
sb.append("SlotName: ").append(getSlotName()).append(",");
if (getPluginName() != null)
sb.append("PluginName: ").append(getPluginName()).append(",");
if (getSecretsManagerAccessRoleArn() != null)
sb.append("SecretsManagerAccessRoleArn: ").append(getSecretsManagerAccessRoleArn()).append(",");
if (getSecretsManagerSecretId() != null)
sb.append("SecretsManagerSecretId: ").append(getSecretsManagerSecretId()).append(",");
if (getTrimSpaceInChar() != null)
sb.append("TrimSpaceInChar: ").append(getTrimSpaceInChar()).append(",");
if (getMapBooleanAsBoolean() != null)
sb.append("MapBooleanAsBoolean: ").append(getMapBooleanAsBoolean()).append(",");
if (getMapJsonbAsClob() != null)
sb.append("MapJsonbAsClob: ").append(getMapJsonbAsClob()).append(",");
if (getMapLongVarcharAs() != null)
sb.append("MapLongVarcharAs: ").append(getMapLongVarcharAs()).append(",");
if (getDatabaseMode() != null)
sb.append("DatabaseMode: ").append(getDatabaseMode()).append(",");
if (getBabelfishDatabaseName() != null)
sb.append("BabelfishDatabaseName: ").append(getBabelfishDatabaseName());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PostgreSQLSettings == false)
return false;
PostgreSQLSettings other = (PostgreSQLSettings) obj;
if (other.getAfterConnectScript() == null ^ this.getAfterConnectScript() == null)
return false;
if (other.getAfterConnectScript() != null && other.getAfterConnectScript().equals(this.getAfterConnectScript()) == false)
return false;
if (other.getCaptureDdls() == null ^ this.getCaptureDdls() == null)
return false;
if (other.getCaptureDdls() != null && other.getCaptureDdls().equals(this.getCaptureDdls()) == false)
return false;
if (other.getMaxFileSize() == null ^ this.getMaxFileSize() == null)
return false;
if (other.getMaxFileSize() != null && other.getMaxFileSize().equals(this.getMaxFileSize()) == false)
return false;
if (other.getDatabaseName() == null ^ this.getDatabaseName() == null)
return false;
if (other.getDatabaseName() != null && other.getDatabaseName().equals(this.getDatabaseName()) == false)
return false;
if (other.getDdlArtifactsSchema() == null ^ this.getDdlArtifactsSchema() == null)
return false;
if (other.getDdlArtifactsSchema() != null && other.getDdlArtifactsSchema().equals(this.getDdlArtifactsSchema()) == false)
return false;
if (other.getExecuteTimeout() == null ^ this.getExecuteTimeout() == null)
return false;
if (other.getExecuteTimeout() != null && other.getExecuteTimeout().equals(this.getExecuteTimeout()) == false)
return false;
if (other.getFailTasksOnLobTruncation() == null ^ this.getFailTasksOnLobTruncation() == null)
return false;
if (other.getFailTasksOnLobTruncation() != null && other.getFailTasksOnLobTruncation().equals(this.getFailTasksOnLobTruncation()) == false)
return false;
if (other.getHeartbeatEnable() == null ^ this.getHeartbeatEnable() == null)
return false;
if (other.getHeartbeatEnable() != null && other.getHeartbeatEnable().equals(this.getHeartbeatEnable()) == false)
return false;
if (other.getHeartbeatSchema() == null ^ this.getHeartbeatSchema() == null)
return false;
if (other.getHeartbeatSchema() != null && other.getHeartbeatSchema().equals(this.getHeartbeatSchema()) == false)
return false;
if (other.getHeartbeatFrequency() == null ^ this.getHeartbeatFrequency() == null)
return false;
if (other.getHeartbeatFrequency() != null && other.getHeartbeatFrequency().equals(this.getHeartbeatFrequency()) == false)
return false;
if (other.getPassword() == null ^ this.getPassword() == null)
return false;
if (other.getPassword() != null && other.getPassword().equals(this.getPassword()) == false)
return false;
if (other.getPort() == null ^ this.getPort() == null)
return false;
if (other.getPort() != null && other.getPort().equals(this.getPort()) == false)
return false;
if (other.getServerName() == null ^ this.getServerName() == null)
return false;
if (other.getServerName() != null && other.getServerName().equals(this.getServerName()) == false)
return false;
if (other.getUsername() == null ^ this.getUsername() == null)
return false;
if (other.getUsername() != null && other.getUsername().equals(this.getUsername()) == false)
return false;
if (other.getSlotName() == null ^ this.getSlotName() == null)
return false;
if (other.getSlotName() != null && other.getSlotName().equals(this.getSlotName()) == false)
return false;
if (other.getPluginName() == null ^ this.getPluginName() == null)
return false;
if (other.getPluginName() != null && other.getPluginName().equals(this.getPluginName()) == false)
return false;
if (other.getSecretsManagerAccessRoleArn() == null ^ this.getSecretsManagerAccessRoleArn() == null)
return false;
if (other.getSecretsManagerAccessRoleArn() != null && other.getSecretsManagerAccessRoleArn().equals(this.getSecretsManagerAccessRoleArn()) == false)
return false;
if (other.getSecretsManagerSecretId() == null ^ this.getSecretsManagerSecretId() == null)
return false;
if (other.getSecretsManagerSecretId() != null && other.getSecretsManagerSecretId().equals(this.getSecretsManagerSecretId()) == false)
return false;
if (other.getTrimSpaceInChar() == null ^ this.getTrimSpaceInChar() == null)
return false;
if (other.getTrimSpaceInChar() != null && other.getTrimSpaceInChar().equals(this.getTrimSpaceInChar()) == false)
return false;
if (other.getMapBooleanAsBoolean() == null ^ this.getMapBooleanAsBoolean() == null)
return false;
if (other.getMapBooleanAsBoolean() != null && other.getMapBooleanAsBoolean().equals(this.getMapBooleanAsBoolean()) == false)
return false;
if (other.getMapJsonbAsClob() == null ^ this.getMapJsonbAsClob() == null)
return false;
if (other.getMapJsonbAsClob() != null && other.getMapJsonbAsClob().equals(this.getMapJsonbAsClob()) == false)
return false;
if (other.getMapLongVarcharAs() == null ^ this.getMapLongVarcharAs() == null)
return false;
if (other.getMapLongVarcharAs() != null && other.getMapLongVarcharAs().equals(this.getMapLongVarcharAs()) == false)
return false;
if (other.getDatabaseMode() == null ^ this.getDatabaseMode() == null)
return false;
if (other.getDatabaseMode() != null && other.getDatabaseMode().equals(this.getDatabaseMode()) == false)
return false;
if (other.getBabelfishDatabaseName() == null ^ this.getBabelfishDatabaseName() == null)
return false;
if (other.getBabelfishDatabaseName() != null && other.getBabelfishDatabaseName().equals(this.getBabelfishDatabaseName()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAfterConnectScript() == null) ? 0 : getAfterConnectScript().hashCode());
hashCode = prime * hashCode + ((getCaptureDdls() == null) ? 0 : getCaptureDdls().hashCode());
hashCode = prime * hashCode + ((getMaxFileSize() == null) ? 0 : getMaxFileSize().hashCode());
hashCode = prime * hashCode + ((getDatabaseName() == null) ? 0 : getDatabaseName().hashCode());
hashCode = prime * hashCode + ((getDdlArtifactsSchema() == null) ? 0 : getDdlArtifactsSchema().hashCode());
hashCode = prime * hashCode + ((getExecuteTimeout() == null) ? 0 : getExecuteTimeout().hashCode());
hashCode = prime * hashCode + ((getFailTasksOnLobTruncation() == null) ? 0 : getFailTasksOnLobTruncation().hashCode());
hashCode = prime * hashCode + ((getHeartbeatEnable() == null) ? 0 : getHeartbeatEnable().hashCode());
hashCode = prime * hashCode + ((getHeartbeatSchema() == null) ? 0 : getHeartbeatSchema().hashCode());
hashCode = prime * hashCode + ((getHeartbeatFrequency() == null) ? 0 : getHeartbeatFrequency().hashCode());
hashCode = prime * hashCode + ((getPassword() == null) ? 0 : getPassword().hashCode());
hashCode = prime * hashCode + ((getPort() == null) ? 0 : getPort().hashCode());
hashCode = prime * hashCode + ((getServerName() == null) ? 0 : getServerName().hashCode());
hashCode = prime * hashCode + ((getUsername() == null) ? 0 : getUsername().hashCode());
hashCode = prime * hashCode + ((getSlotName() == null) ? 0 : getSlotName().hashCode());
hashCode = prime * hashCode + ((getPluginName() == null) ? 0 : getPluginName().hashCode());
hashCode = prime * hashCode + ((getSecretsManagerAccessRoleArn() == null) ? 0 : getSecretsManagerAccessRoleArn().hashCode());
hashCode = prime * hashCode + ((getSecretsManagerSecretId() == null) ? 0 : getSecretsManagerSecretId().hashCode());
hashCode = prime * hashCode + ((getTrimSpaceInChar() == null) ? 0 : getTrimSpaceInChar().hashCode());
hashCode = prime * hashCode + ((getMapBooleanAsBoolean() == null) ? 0 : getMapBooleanAsBoolean().hashCode());
hashCode = prime * hashCode + ((getMapJsonbAsClob() == null) ? 0 : getMapJsonbAsClob().hashCode());
hashCode = prime * hashCode + ((getMapLongVarcharAs() == null) ? 0 : getMapLongVarcharAs().hashCode());
hashCode = prime * hashCode + ((getDatabaseMode() == null) ? 0 : getDatabaseMode().hashCode());
hashCode = prime * hashCode + ((getBabelfishDatabaseName() == null) ? 0 : getBabelfishDatabaseName().hashCode());
return hashCode;
}
@Override
public PostgreSQLSettings clone() {
try {
return (PostgreSQLSettings) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.databasemigrationservice.model.transform.PostgreSQLSettingsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}