software.amazon.awssdk.services.databasemigration.model.PostgreSQLSettings Maven / Gradle / Ivy
/*
* Copyright 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 software.amazon.awssdk.services.databasemigration.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Provides information that defines a PostgreSQL endpoint.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PostgreSQLSettings implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField AFTER_CONNECT_SCRIPT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AfterConnectScript").getter(getter(PostgreSQLSettings::afterConnectScript))
.setter(setter(Builder::afterConnectScript))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AfterConnectScript").build())
.build();
private static final SdkField CAPTURE_DDLS_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("CaptureDdls").getter(getter(PostgreSQLSettings::captureDdls)).setter(setter(Builder::captureDdls))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CaptureDdls").build()).build();
private static final SdkField MAX_FILE_SIZE_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxFileSize").getter(getter(PostgreSQLSettings::maxFileSize)).setter(setter(Builder::maxFileSize))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxFileSize").build()).build();
private static final SdkField DATABASE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DatabaseName").getter(getter(PostgreSQLSettings::databaseName)).setter(setter(Builder::databaseName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DatabaseName").build()).build();
private static final SdkField DDL_ARTIFACTS_SCHEMA_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DdlArtifactsSchema").getter(getter(PostgreSQLSettings::ddlArtifactsSchema))
.setter(setter(Builder::ddlArtifactsSchema))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DdlArtifactsSchema").build())
.build();
private static final SdkField EXECUTE_TIMEOUT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("ExecuteTimeout").getter(getter(PostgreSQLSettings::executeTimeout))
.setter(setter(Builder::executeTimeout))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExecuteTimeout").build()).build();
private static final SdkField FAIL_TASKS_ON_LOB_TRUNCATION_FIELD = SdkField
. builder(MarshallingType.BOOLEAN).memberName("FailTasksOnLobTruncation")
.getter(getter(PostgreSQLSettings::failTasksOnLobTruncation)).setter(setter(Builder::failTasksOnLobTruncation))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FailTasksOnLobTruncation").build())
.build();
private static final SdkField PASSWORD_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Password").getter(getter(PostgreSQLSettings::password)).setter(setter(Builder::password))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Password").build()).build();
private static final SdkField PORT_FIELD = SdkField. builder(MarshallingType.INTEGER).memberName("Port")
.getter(getter(PostgreSQLSettings::port)).setter(setter(Builder::port))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Port").build()).build();
private static final SdkField SERVER_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ServerName").getter(getter(PostgreSQLSettings::serverName)).setter(setter(Builder::serverName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ServerName").build()).build();
private static final SdkField USERNAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Username").getter(getter(PostgreSQLSettings::username)).setter(setter(Builder::username))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Username").build()).build();
private static final SdkField SLOT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SlotName").getter(getter(PostgreSQLSettings::slotName)).setter(setter(Builder::slotName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SlotName").build()).build();
private static final SdkField SECRETS_MANAGER_ACCESS_ROLE_ARN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("SecretsManagerAccessRoleArn")
.getter(getter(PostgreSQLSettings::secretsManagerAccessRoleArn))
.setter(setter(Builder::secretsManagerAccessRoleArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SecretsManagerAccessRoleArn")
.build()).build();
private static final SdkField SECRETS_MANAGER_SECRET_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SecretsManagerSecretId").getter(getter(PostgreSQLSettings::secretsManagerSecretId))
.setter(setter(Builder::secretsManagerSecretId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SecretsManagerSecretId").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AFTER_CONNECT_SCRIPT_FIELD,
CAPTURE_DDLS_FIELD, MAX_FILE_SIZE_FIELD, DATABASE_NAME_FIELD, DDL_ARTIFACTS_SCHEMA_FIELD, EXECUTE_TIMEOUT_FIELD,
FAIL_TASKS_ON_LOB_TRUNCATION_FIELD, PASSWORD_FIELD, PORT_FIELD, SERVER_NAME_FIELD, USERNAME_FIELD, SLOT_NAME_FIELD,
SECRETS_MANAGER_ACCESS_ROLE_ARN_FIELD, SECRETS_MANAGER_SECRET_ID_FIELD));
private static final long serialVersionUID = 1L;
private final String afterConnectScript;
private final Boolean captureDdls;
private final Integer maxFileSize;
private final String databaseName;
private final String ddlArtifactsSchema;
private final Integer executeTimeout;
private final Boolean failTasksOnLobTruncation;
private final String password;
private final Integer port;
private final String serverName;
private final String username;
private final String slotName;
private final String secretsManagerAccessRoleArn;
private final String secretsManagerSecretId;
private PostgreSQLSettings(BuilderImpl builder) {
this.afterConnectScript = builder.afterConnectScript;
this.captureDdls = builder.captureDdls;
this.maxFileSize = builder.maxFileSize;
this.databaseName = builder.databaseName;
this.ddlArtifactsSchema = builder.ddlArtifactsSchema;
this.executeTimeout = builder.executeTimeout;
this.failTasksOnLobTruncation = builder.failTasksOnLobTruncation;
this.password = builder.password;
this.port = builder.port;
this.serverName = builder.serverName;
this.username = builder.username;
this.slotName = builder.slotName;
this.secretsManagerAccessRoleArn = builder.secretsManagerAccessRoleArn;
this.secretsManagerSecretId = builder.secretsManagerSecretId;
}
/**
*
* For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to
* reduce the time it takes to bulk load data.
*
*
* Example: afterConnectScript=SET session_replication_role='replica'
*
*
* @return For use with change data capture (CDC) only, this attribute has AWS 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 final String afterConnectScript() {
return afterConnectScript;
}
/**
*
* To capture DDL events, AWS 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.
*
*
* @return To capture DDL events, AWS 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 final Boolean captureDdls() {
return captureDdls;
}
/**
*
* Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
*
*
* Example: maxFileSize=512
*
*
* @return Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
*
* Example: maxFileSize=512
*/
public final Integer maxFileSize() {
return maxFileSize;
}
/**
*
* Database name for the endpoint.
*
*
* @return Database name for the endpoint.
*/
public final String databaseName() {
return databaseName;
}
/**
*
* The schema in which the operational DDL database artifacts are created.
*
*
* Example: ddlArtifactsSchema=xyzddlschema;
*
*
* @return The schema in which the operational DDL database artifacts are created.
*
* Example: ddlArtifactsSchema=xyzddlschema;
*/
public final String ddlArtifactsSchema() {
return ddlArtifactsSchema;
}
/**
*
* Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
*
*
* Example: executeTimeout=100;
*
*
* @return Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60
* seconds.
*
* Example: executeTimeout=100;
*/
public final Integer executeTimeout() {
return executeTimeout;
}
/**
*
* 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.
*
*
* @return 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 final Boolean failTasksOnLobTruncation() {
return failTasksOnLobTruncation;
}
/**
*
* Endpoint connection password.
*
*
* @return Endpoint connection password.
*/
public final String password() {
return password;
}
/**
*
* Endpoint TCP port.
*
*
* @return Endpoint TCP port.
*/
public final Integer port() {
return port;
}
/**
*
* Fully qualified domain name of the endpoint.
*
*
* @return Fully qualified domain name of the endpoint.
*/
public final String serverName() {
return serverName;
}
/**
*
* Endpoint connection user name.
*
*
* @return Endpoint connection user name.
*/
public final String username() {
return username;
}
/**
*
* Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance.
*
*
* When used with the AWS DMS API CdcStartPosition request parameter, this attribute also enables using
* native CDC start points.
*
*
* @return Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source
* instance.
*
* When used with the AWS DMS API CdcStartPosition request parameter, this attribute also
* enables using native CDC start points.
*/
public final String slotName() {
return slotName;
}
/**
*
* The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the
* required permissions to access the value in SecretsManagerSecret. SecretsManagerSecret
* has the value of the AWS 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 AWS Database Migration Service resources in the AWS Database Migration Service
* User Guide.
*
*
*
* @return The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and
* grants the required permissions to access the value in SecretsManagerSecret.
* SecretsManagerSecret has the value of the AWS 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 AWS Database Migration Service resources in the AWS Database Migration
* Service User Guide.
*
*/
public final String secretsManagerAccessRoleArn() {
return secretsManagerAccessRoleArn;
}
/**
*
* The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the PostgreSQL
* endpoint connection details.
*
*
* @return The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the
* PostgreSQL endpoint connection details.
*/
public final String secretsManagerSecretId() {
return secretsManagerSecretId;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(afterConnectScript());
hashCode = 31 * hashCode + Objects.hashCode(captureDdls());
hashCode = 31 * hashCode + Objects.hashCode(maxFileSize());
hashCode = 31 * hashCode + Objects.hashCode(databaseName());
hashCode = 31 * hashCode + Objects.hashCode(ddlArtifactsSchema());
hashCode = 31 * hashCode + Objects.hashCode(executeTimeout());
hashCode = 31 * hashCode + Objects.hashCode(failTasksOnLobTruncation());
hashCode = 31 * hashCode + Objects.hashCode(password());
hashCode = 31 * hashCode + Objects.hashCode(port());
hashCode = 31 * hashCode + Objects.hashCode(serverName());
hashCode = 31 * hashCode + Objects.hashCode(username());
hashCode = 31 * hashCode + Objects.hashCode(slotName());
hashCode = 31 * hashCode + Objects.hashCode(secretsManagerAccessRoleArn());
hashCode = 31 * hashCode + Objects.hashCode(secretsManagerSecretId());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof PostgreSQLSettings)) {
return false;
}
PostgreSQLSettings other = (PostgreSQLSettings) obj;
return Objects.equals(afterConnectScript(), other.afterConnectScript())
&& Objects.equals(captureDdls(), other.captureDdls()) && Objects.equals(maxFileSize(), other.maxFileSize())
&& Objects.equals(databaseName(), other.databaseName())
&& Objects.equals(ddlArtifactsSchema(), other.ddlArtifactsSchema())
&& Objects.equals(executeTimeout(), other.executeTimeout())
&& Objects.equals(failTasksOnLobTruncation(), other.failTasksOnLobTruncation())
&& Objects.equals(password(), other.password()) && Objects.equals(port(), other.port())
&& Objects.equals(serverName(), other.serverName()) && Objects.equals(username(), other.username())
&& Objects.equals(slotName(), other.slotName())
&& Objects.equals(secretsManagerAccessRoleArn(), other.secretsManagerAccessRoleArn())
&& Objects.equals(secretsManagerSecretId(), other.secretsManagerSecretId());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("PostgreSQLSettings").add("AfterConnectScript", afterConnectScript())
.add("CaptureDdls", captureDdls()).add("MaxFileSize", maxFileSize()).add("DatabaseName", databaseName())
.add("DdlArtifactsSchema", ddlArtifactsSchema()).add("ExecuteTimeout", executeTimeout())
.add("FailTasksOnLobTruncation", failTasksOnLobTruncation())
.add("Password", password() == null ? null : "*** Sensitive Data Redacted ***").add("Port", port())
.add("ServerName", serverName()).add("Username", username()).add("SlotName", slotName())
.add("SecretsManagerAccessRoleArn", secretsManagerAccessRoleArn())
.add("SecretsManagerSecretId", secretsManagerSecretId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AfterConnectScript":
return Optional.ofNullable(clazz.cast(afterConnectScript()));
case "CaptureDdls":
return Optional.ofNullable(clazz.cast(captureDdls()));
case "MaxFileSize":
return Optional.ofNullable(clazz.cast(maxFileSize()));
case "DatabaseName":
return Optional.ofNullable(clazz.cast(databaseName()));
case "DdlArtifactsSchema":
return Optional.ofNullable(clazz.cast(ddlArtifactsSchema()));
case "ExecuteTimeout":
return Optional.ofNullable(clazz.cast(executeTimeout()));
case "FailTasksOnLobTruncation":
return Optional.ofNullable(clazz.cast(failTasksOnLobTruncation()));
case "Password":
return Optional.ofNullable(clazz.cast(password()));
case "Port":
return Optional.ofNullable(clazz.cast(port()));
case "ServerName":
return Optional.ofNullable(clazz.cast(serverName()));
case "Username":
return Optional.ofNullable(clazz.cast(username()));
case "SlotName":
return Optional.ofNullable(clazz.cast(slotName()));
case "SecretsManagerAccessRoleArn":
return Optional.ofNullable(clazz.cast(secretsManagerAccessRoleArn()));
case "SecretsManagerSecretId":
return Optional.ofNullable(clazz.cast(secretsManagerSecretId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PostgreSQLSettings) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers
* to reduce the time it takes to bulk load data.
*
*
* Example: afterConnectScript=SET session_replication_role='replica'
*
*
* @param afterConnectScript
* For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user
* triggers to reduce the time it takes to bulk load data.
*
* Example: afterConnectScript=SET session_replication_role='replica'
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder afterConnectScript(String afterConnectScript);
/**
*
* To capture DDL events, AWS 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.
*
*
* @param captureDdls
* To capture DDL events, AWS 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder captureDdls(Boolean captureDdls);
/**
*
* Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
*
*
* Example: maxFileSize=512
*
*
* @param maxFileSize
* Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
*
* Example: maxFileSize=512
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxFileSize(Integer maxFileSize);
/**
*
* Database name for the endpoint.
*
*
* @param databaseName
* Database name for the endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder databaseName(String databaseName);
/**
*
* The schema in which the operational DDL database artifacts are created.
*
*
* Example: ddlArtifactsSchema=xyzddlschema;
*
*
* @param ddlArtifactsSchema
* The schema in which the operational DDL database artifacts are created.
*
* Example: ddlArtifactsSchema=xyzddlschema;
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ddlArtifactsSchema(String ddlArtifactsSchema);
/**
*
* Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
*
*
* Example: executeTimeout=100;
*
*
* @param executeTimeout
* Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60
* seconds.
*
* Example: executeTimeout=100;
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder executeTimeout(Integer executeTimeout);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder failTasksOnLobTruncation(Boolean failTasksOnLobTruncation);
/**
*
* Endpoint connection password.
*
*
* @param password
* Endpoint connection password.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder password(String password);
/**
*
* Endpoint TCP port.
*
*
* @param port
* Endpoint TCP port.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder port(Integer port);
/**
*
* Fully qualified domain name of the endpoint.
*
*
* @param serverName
* Fully qualified domain name of the endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder serverName(String serverName);
/**
*
* Endpoint connection user name.
*
*
* @param username
* Endpoint connection user name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder username(String username);
/**
*
* Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source
* instance.
*
*
* When used with the AWS DMS API CdcStartPosition request parameter, this attribute also enables
* using native CDC start points.
*
*
* @param slotName
* Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source
* instance.
*
* When used with the AWS DMS API CdcStartPosition request parameter, this attribute also
* enables using native CDC start points.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder slotName(String slotName);
/**
*
* The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants
* the required permissions to access the value in SecretsManagerSecret.
* SecretsManagerSecret has the value of the AWS 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 AWS Database Migration Service resources in the AWS Database Migration
* Service User Guide.
*
*
*
* @param secretsManagerAccessRoleArn
* The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and
* grants the required permissions to access the value in SecretsManagerSecret.
* SecretsManagerSecret has the value of the AWS 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 AWS Database Migration Service resources in the AWS Database Migration
* Service User Guide.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn);
/**
*
* The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the
* PostgreSQL endpoint connection details.
*
*
* @param secretsManagerSecretId
* The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the
* PostgreSQL endpoint connection details.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder secretsManagerSecretId(String secretsManagerSecretId);
}
static final class BuilderImpl implements Builder {
private String afterConnectScript;
private Boolean captureDdls;
private Integer maxFileSize;
private String databaseName;
private String ddlArtifactsSchema;
private Integer executeTimeout;
private Boolean failTasksOnLobTruncation;
private String password;
private Integer port;
private String serverName;
private String username;
private String slotName;
private String secretsManagerAccessRoleArn;
private String secretsManagerSecretId;
private BuilderImpl() {
}
private BuilderImpl(PostgreSQLSettings model) {
afterConnectScript(model.afterConnectScript);
captureDdls(model.captureDdls);
maxFileSize(model.maxFileSize);
databaseName(model.databaseName);
ddlArtifactsSchema(model.ddlArtifactsSchema);
executeTimeout(model.executeTimeout);
failTasksOnLobTruncation(model.failTasksOnLobTruncation);
password(model.password);
port(model.port);
serverName(model.serverName);
username(model.username);
slotName(model.slotName);
secretsManagerAccessRoleArn(model.secretsManagerAccessRoleArn);
secretsManagerSecretId(model.secretsManagerSecretId);
}
public final String getAfterConnectScript() {
return afterConnectScript;
}
@Override
public final Builder afterConnectScript(String afterConnectScript) {
this.afterConnectScript = afterConnectScript;
return this;
}
public final void setAfterConnectScript(String afterConnectScript) {
this.afterConnectScript = afterConnectScript;
}
public final Boolean getCaptureDdls() {
return captureDdls;
}
@Override
public final Builder captureDdls(Boolean captureDdls) {
this.captureDdls = captureDdls;
return this;
}
public final void setCaptureDdls(Boolean captureDdls) {
this.captureDdls = captureDdls;
}
public final Integer getMaxFileSize() {
return maxFileSize;
}
@Override
public final Builder maxFileSize(Integer maxFileSize) {
this.maxFileSize = maxFileSize;
return this;
}
public final void setMaxFileSize(Integer maxFileSize) {
this.maxFileSize = maxFileSize;
}
public final String getDatabaseName() {
return databaseName;
}
@Override
public final Builder databaseName(String databaseName) {
this.databaseName = databaseName;
return this;
}
public final void setDatabaseName(String databaseName) {
this.databaseName = databaseName;
}
public final String getDdlArtifactsSchema() {
return ddlArtifactsSchema;
}
@Override
public final Builder ddlArtifactsSchema(String ddlArtifactsSchema) {
this.ddlArtifactsSchema = ddlArtifactsSchema;
return this;
}
public final void setDdlArtifactsSchema(String ddlArtifactsSchema) {
this.ddlArtifactsSchema = ddlArtifactsSchema;
}
public final Integer getExecuteTimeout() {
return executeTimeout;
}
@Override
public final Builder executeTimeout(Integer executeTimeout) {
this.executeTimeout = executeTimeout;
return this;
}
public final void setExecuteTimeout(Integer executeTimeout) {
this.executeTimeout = executeTimeout;
}
public final Boolean getFailTasksOnLobTruncation() {
return failTasksOnLobTruncation;
}
@Override
public final Builder failTasksOnLobTruncation(Boolean failTasksOnLobTruncation) {
this.failTasksOnLobTruncation = failTasksOnLobTruncation;
return this;
}
public final void setFailTasksOnLobTruncation(Boolean failTasksOnLobTruncation) {
this.failTasksOnLobTruncation = failTasksOnLobTruncation;
}
public final String getPassword() {
return password;
}
@Override
public final Builder password(String password) {
this.password = password;
return this;
}
public final void setPassword(String password) {
this.password = password;
}
public final Integer getPort() {
return port;
}
@Override
public final Builder port(Integer port) {
this.port = port;
return this;
}
public final void setPort(Integer port) {
this.port = port;
}
public final String getServerName() {
return serverName;
}
@Override
public final Builder serverName(String serverName) {
this.serverName = serverName;
return this;
}
public final void setServerName(String serverName) {
this.serverName = serverName;
}
public final String getUsername() {
return username;
}
@Override
public final Builder username(String username) {
this.username = username;
return this;
}
public final void setUsername(String username) {
this.username = username;
}
public final String getSlotName() {
return slotName;
}
@Override
public final Builder slotName(String slotName) {
this.slotName = slotName;
return this;
}
public final void setSlotName(String slotName) {
this.slotName = slotName;
}
public final String getSecretsManagerAccessRoleArn() {
return secretsManagerAccessRoleArn;
}
@Override
public final Builder secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn) {
this.secretsManagerAccessRoleArn = secretsManagerAccessRoleArn;
return this;
}
public final void setSecretsManagerAccessRoleArn(String secretsManagerAccessRoleArn) {
this.secretsManagerAccessRoleArn = secretsManagerAccessRoleArn;
}
public final String getSecretsManagerSecretId() {
return secretsManagerSecretId;
}
@Override
public final Builder secretsManagerSecretId(String secretsManagerSecretId) {
this.secretsManagerSecretId = secretsManagerSecretId;
return this;
}
public final void setSecretsManagerSecretId(String secretsManagerSecretId) {
this.secretsManagerSecretId = secretsManagerSecretId;
}
@Override
public PostgreSQLSettings build() {
return new PostgreSQLSettings(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}