/* * 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; /** *
* Provides information that defines an IBM Db2 LUW endpoint. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class IBMDb2Settings implements Serializable, Cloneable, StructuredPojo { /** ** Database name for the endpoint. *
*/ private String databaseName; /** ** Endpoint connection password. *
*/ private String password; /** ** Endpoint TCP port. The default value is 50000. *
*/ private Integer port; /** ** Fully qualified domain name of the endpoint. *
*/ private String serverName; /** ** Enables ongoing replication (CDC) as a BOOLEAN value. The default is true. *
*/ private Boolean setDataCaptureChanges; /** ** For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the * replication to start. *
*/ private String currentLsn; /** ** Maximum number of bytes per read, as a NUMBER value. The default is 64 KB. *
*/ private Integer maxKBytesPerRead; /** ** Endpoint connection user name. *
*/ private String username; /** *
* The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the
* required permissions to access the value in SecretsManagerSecret
. The role must allow the
* iam:PassRole
action. SecretsManagerSecret
has the value of the Amazon Web Services
* Secrets Manager secret that allows access to the Db2 LUW endpoint.
*
* You can specify one of two sets of values for these permissions. You can specify the values for this setting and
* SecretsManagerSecretId
. Or you can specify clear-text values for UserName
,
* Password
, ServerName
, and Port
. You can't specify both. For more
* information on creating this SecretsManagerSecret
and the SecretsManagerAccessRoleArn
* and SecretsManagerSecretId
required to access it, see Using
* secrets to access Database Migration Service resources in the Database Migration Service User Guide.
*
* The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the Db2 LUW
* endpoint connection details.
*
* Database name for the endpoint. *
* * @param databaseName * Database name for the endpoint. */ public void setDatabaseName(String databaseName) { this.databaseName = databaseName; } /** ** Database name for the endpoint. *
* * @return Database name for the endpoint. */ public String getDatabaseName() { return this.databaseName; } /** ** 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. */ public IBMDb2Settings withDatabaseName(String databaseName) { setDatabaseName(databaseName); return this; } /** ** Endpoint connection password. *
* * @param password * Endpoint connection password. */ public void setPassword(String password) { this.password = password; } /** ** Endpoint connection password. *
* * @return Endpoint connection password. */ public String getPassword() { return this.password; } /** ** Endpoint connection password. *
* * @param password * Endpoint connection password. * @return Returns a reference to this object so that method calls can be chained together. */ public IBMDb2Settings withPassword(String password) { setPassword(password); return this; } /** ** Endpoint TCP port. The default value is 50000. *
* * @param port * Endpoint TCP port. The default value is 50000. */ public void setPort(Integer port) { this.port = port; } /** ** Endpoint TCP port. The default value is 50000. *
* * @return Endpoint TCP port. The default value is 50000. */ public Integer getPort() { return this.port; } /** ** Endpoint TCP port. The default value is 50000. *
* * @param port * Endpoint TCP port. The default value is 50000. * @return Returns a reference to this object so that method calls can be chained together. */ public IBMDb2Settings withPort(Integer port) { setPort(port); return this; } /** ** Fully qualified domain name of the endpoint. *
* * @param serverName * Fully qualified domain name of the endpoint. */ public void setServerName(String serverName) { this.serverName = serverName; } /** ** Fully qualified domain name of the endpoint. *
* * @return Fully qualified domain name of the endpoint. */ public String getServerName() { return this.serverName; } /** ** 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. */ public IBMDb2Settings withServerName(String serverName) { setServerName(serverName); return this; } /** ** Enables ongoing replication (CDC) as a BOOLEAN value. The default is true. *
* * @param setDataCaptureChanges * Enables ongoing replication (CDC) as a BOOLEAN value. The default is true. */ public void setSetDataCaptureChanges(Boolean setDataCaptureChanges) { this.setDataCaptureChanges = setDataCaptureChanges; } /** ** Enables ongoing replication (CDC) as a BOOLEAN value. The default is true. *
* * @return Enables ongoing replication (CDC) as a BOOLEAN value. The default is true. */ public Boolean getSetDataCaptureChanges() { return this.setDataCaptureChanges; } /** ** Enables ongoing replication (CDC) as a BOOLEAN value. The default is true. *
* * @param setDataCaptureChanges * Enables ongoing replication (CDC) as a BOOLEAN value. The default is true. * @return Returns a reference to this object so that method calls can be chained together. */ public IBMDb2Settings withSetDataCaptureChanges(Boolean setDataCaptureChanges) { setSetDataCaptureChanges(setDataCaptureChanges); return this; } /** ** Enables ongoing replication (CDC) as a BOOLEAN value. The default is true. *
* * @return Enables ongoing replication (CDC) as a BOOLEAN value. The default is true. */ public Boolean isSetDataCaptureChanges() { return this.setDataCaptureChanges; } /** ** For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the * replication to start. *
* * @param currentLsn * For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the * replication to start. */ public void setCurrentLsn(String currentLsn) { this.currentLsn = currentLsn; } /** ** For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the * replication to start. *
* * @return For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the * replication to start. */ public String getCurrentLsn() { return this.currentLsn; } /** ** For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the * replication to start. *
* * @param currentLsn * For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the * replication to start. * @return Returns a reference to this object so that method calls can be chained together. */ public IBMDb2Settings withCurrentLsn(String currentLsn) { setCurrentLsn(currentLsn); return this; } /** ** Maximum number of bytes per read, as a NUMBER value. The default is 64 KB. *
* * @param maxKBytesPerRead * Maximum number of bytes per read, as a NUMBER value. The default is 64 KB. */ public void setMaxKBytesPerRead(Integer maxKBytesPerRead) { this.maxKBytesPerRead = maxKBytesPerRead; } /** ** Maximum number of bytes per read, as a NUMBER value. The default is 64 KB. *
* * @return Maximum number of bytes per read, as a NUMBER value. The default is 64 KB. */ public Integer getMaxKBytesPerRead() { return this.maxKBytesPerRead; } /** ** Maximum number of bytes per read, as a NUMBER value. The default is 64 KB. *
* * @param maxKBytesPerRead * Maximum number of bytes per read, as a NUMBER value. The default is 64 KB. * @return Returns a reference to this object so that method calls can be chained together. */ public IBMDb2Settings withMaxKBytesPerRead(Integer maxKBytesPerRead) { setMaxKBytesPerRead(maxKBytesPerRead); return this; } /** ** Endpoint connection user name. *
* * @param username * Endpoint connection user name. */ public void setUsername(String username) { this.username = username; } /** ** Endpoint connection user name. *
* * @return Endpoint connection user name. */ public String getUsername() { return this.username; } /** ** 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. */ public IBMDb2Settings withUsername(String username) { setUsername(username); return this; } /** *
* The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the
* required permissions to access the value in SecretsManagerSecret
. The role must allow the
* iam:PassRole
action. SecretsManagerSecret
has the value of the Amazon Web Services
* Secrets Manager secret that allows access to the Db2 LUW endpoint.
*
* You can specify one of two sets of values for these permissions. You can specify the values for this setting and
* SecretsManagerSecretId
. Or you can specify clear-text values for UserName
,
* Password
, ServerName
, and Port
. You can't specify both. For more
* information on creating this SecretsManagerSecret
and the SecretsManagerAccessRoleArn
* and SecretsManagerSecretId
required to access it, see Using
* secrets to access Database Migration Service resources in the Database Migration Service User Guide.
*
SecretsManagerSecret
. The role must allow the
* iam:PassRole
action. SecretsManagerSecret
has the value of the Amazon Web
* Services Secrets Manager secret that allows access to the Db2 LUW endpoint.
* You can specify one of two sets of values for these permissions. You can specify the values for this
* setting and SecretsManagerSecretId
. Or you can specify clear-text values for
* UserName
, Password
, ServerName
, and Port
. You can't
* specify both. For more information on creating this SecretsManagerSecret
and the
* SecretsManagerAccessRoleArn
and SecretsManagerSecretId
required to access it,
* see Using secrets to access Database Migration Service resources in the Database Migration Service
* User Guide.
*
* The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the
* required permissions to access the value in SecretsManagerSecret
. The role must allow the
* iam:PassRole
action. SecretsManagerSecret
has the value of the Amazon Web Services
* Secrets Manager secret that allows access to the Db2 LUW endpoint.
*
* You can specify one of two sets of values for these permissions. You can specify the values for this setting and
* SecretsManagerSecretId
. Or you can specify clear-text values for UserName
,
* Password
, ServerName
, and Port
. You can't specify both. For more
* information on creating this SecretsManagerSecret
and the SecretsManagerAccessRoleArn
* and SecretsManagerSecretId
required to access it, see Using
* secrets to access Database Migration Service resources in the Database Migration Service User Guide.
*
SecretsManagerSecret
. The role must allow
* the iam:PassRole
action. SecretsManagerSecret
has the value of the Amazon Web
* Services Secrets Manager secret that allows access to the Db2 LUW endpoint.
* You can specify one of two sets of values for these permissions. You can specify the values for this
* setting and SecretsManagerSecretId
. Or you can specify clear-text values for
* UserName
, Password
, ServerName
, and Port
. You can't
* specify both. For more information on creating this SecretsManagerSecret
and the
* SecretsManagerAccessRoleArn
and SecretsManagerSecretId
required to access it,
* see Using secrets to access Database Migration Service resources in the Database Migration Service
* User Guide.
*
* The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the
* required permissions to access the value in SecretsManagerSecret
. The role must allow the
* iam:PassRole
action. SecretsManagerSecret
has the value of the Amazon Web Services
* Secrets Manager secret that allows access to the Db2 LUW endpoint.
*
* You can specify one of two sets of values for these permissions. You can specify the values for this setting and
* SecretsManagerSecretId
. Or you can specify clear-text values for UserName
,
* Password
, ServerName
, and Port
. You can't specify both. For more
* information on creating this SecretsManagerSecret
and the SecretsManagerAccessRoleArn
* and SecretsManagerSecretId
required to access it, see Using
* secrets to access Database Migration Service resources in the Database Migration Service User Guide.
*
SecretsManagerSecret
. The role must allow the
* iam:PassRole
action. SecretsManagerSecret
has the value of the Amazon Web
* Services Secrets Manager secret that allows access to the Db2 LUW endpoint.
* You can specify one of two sets of values for these permissions. You can specify the values for this
* setting and SecretsManagerSecretId
. Or you can specify clear-text values for
* UserName
, Password
, ServerName
, and Port
. You can't
* specify both. For more information on creating this SecretsManagerSecret
and the
* SecretsManagerAccessRoleArn
and SecretsManagerSecretId
required to access it,
* see Using secrets to access Database Migration Service resources in the Database Migration Service
* User Guide.
*
* The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the Db2 LUW
* endpoint connection details.
*
SecretsManagerSecret
that contains the Db2
* LUW endpoint connection details.
*/
public void setSecretsManagerSecretId(String secretsManagerSecretId) {
this.secretsManagerSecretId = secretsManagerSecretId;
}
/**
*
* The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the Db2 LUW
* endpoint connection details.
*
SecretsManagerSecret
that contains the
* Db2 LUW endpoint connection details.
*/
public String getSecretsManagerSecretId() {
return this.secretsManagerSecretId;
}
/**
*
* The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the Db2 LUW
* endpoint connection details.
*
SecretsManagerSecret
that contains the Db2
* LUW endpoint connection details.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IBMDb2Settings withSecretsManagerSecretId(String secretsManagerSecretId) {
setSecretsManagerSecretId(secretsManagerSecretId);
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 (getDatabaseName() != null)
sb.append("DatabaseName: ").append(getDatabaseName()).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 (getSetDataCaptureChanges() != null)
sb.append("SetDataCaptureChanges: ").append(getSetDataCaptureChanges()).append(",");
if (getCurrentLsn() != null)
sb.append("CurrentLsn: ").append(getCurrentLsn()).append(",");
if (getMaxKBytesPerRead() != null)
sb.append("MaxKBytesPerRead: ").append(getMaxKBytesPerRead()).append(",");
if (getUsername() != null)
sb.append("Username: ").append(getUsername()).append(",");
if (getSecretsManagerAccessRoleArn() != null)
sb.append("SecretsManagerAccessRoleArn: ").append(getSecretsManagerAccessRoleArn()).append(",");
if (getSecretsManagerSecretId() != null)
sb.append("SecretsManagerSecretId: ").append(getSecretsManagerSecretId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof IBMDb2Settings == false)
return false;
IBMDb2Settings other = (IBMDb2Settings) obj;
if (other.getDatabaseName() == null ^ this.getDatabaseName() == null)
return false;
if (other.getDatabaseName() != null && other.getDatabaseName().equals(this.getDatabaseName()) == 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.getSetDataCaptureChanges() == null ^ this.getSetDataCaptureChanges() == null)
return false;
if (other.getSetDataCaptureChanges() != null && other.getSetDataCaptureChanges().equals(this.getSetDataCaptureChanges()) == false)
return false;
if (other.getCurrentLsn() == null ^ this.getCurrentLsn() == null)
return false;
if (other.getCurrentLsn() != null && other.getCurrentLsn().equals(this.getCurrentLsn()) == false)
return false;
if (other.getMaxKBytesPerRead() == null ^ this.getMaxKBytesPerRead() == null)
return false;
if (other.getMaxKBytesPerRead() != null && other.getMaxKBytesPerRead().equals(this.getMaxKBytesPerRead()) == 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.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;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDatabaseName() == null) ? 0 : getDatabaseName().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 + ((getSetDataCaptureChanges() == null) ? 0 : getSetDataCaptureChanges().hashCode());
hashCode = prime * hashCode + ((getCurrentLsn() == null) ? 0 : getCurrentLsn().hashCode());
hashCode = prime * hashCode + ((getMaxKBytesPerRead() == null) ? 0 : getMaxKBytesPerRead().hashCode());
hashCode = prime * hashCode + ((getUsername() == null) ? 0 : getUsername().hashCode());
hashCode = prime * hashCode + ((getSecretsManagerAccessRoleArn() == null) ? 0 : getSecretsManagerAccessRoleArn().hashCode());
hashCode = prime * hashCode + ((getSecretsManagerSecretId() == null) ? 0 : getSecretsManagerSecretId().hashCode());
return hashCode;
}
@Override
public IBMDb2Settings clone() {
try {
return (IBMDb2Settings) 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.IBMDb2SettingsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}