com.amazonaws.services.rds.model.PromoteReadReplicaRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 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.rds.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.rds.AmazonRDS#promoteReadReplica(PromoteReadReplicaRequest) PromoteReadReplica operation}.
*
* Promotes a read replica DB instance to a standalone DB instance.
*
*
* @see com.amazonaws.services.rds.AmazonRDS#promoteReadReplica(PromoteReadReplicaRequest)
*/
public class PromoteReadReplicaRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The DB instance identifier. This value is stored as a lowercase
* string. Constraints:
- Must be the identifier for an
* existing read replica DB instance
- Must contain from 1 to 63
* alphanumeric characters or hyphens
- First character must be a
* letter
- Cannot end with a hyphen or contain two consecutive
* hyphens
Example: mydbinstance
*/
private String dBInstanceIdentifier;
/**
* The number of days to retain automated backups. Setting this parameter
* to a positive number enables backups. Setting this parameter to 0
* disables automated backups.
Default: 1
Constraints:
* - Must be a value from 0 to 8
*/
private Integer backupRetentionPeriod;
/**
* The daily time range during which automated backups are created if
* automated backups are enabled, using the
* BackupRetentionPeriod parameter. Default: A 30-minute
* window selected at random from an 8-hour block of time per region. See
* the Amazon RDS User Guide for the time blocks for each region from
* which the default backup windows are assigned.
Constraints: Must
* be in the format hh24:mi-hh24:mi. Times should be
* Universal Time Coordinated (UTC). Must not conflict with the preferred
* maintenance window. Must be at least 30 minutes.
*/
private String preferredBackupWindow;
/**
* The DB instance identifier. This value is stored as a lowercase
* string.
Constraints:
- Must be the identifier for an
* existing read replica DB instance
- Must contain from 1 to 63
* alphanumeric characters or hyphens
- First character must be a
* letter
- Cannot end with a hyphen or contain two consecutive
* hyphens
Example: mydbinstance
*
* @return The DB instance identifier. This value is stored as a lowercase
* string.
Constraints:
- Must be the identifier for an
* existing read replica DB instance
- Must contain from 1 to 63
* alphanumeric characters or hyphens
- First character must be a
* letter
- Cannot end with a hyphen or contain two consecutive
* hyphens
Example: mydbinstance
*/
public String getDBInstanceIdentifier() {
return dBInstanceIdentifier;
}
/**
* The DB instance identifier. This value is stored as a lowercase
* string.
Constraints:
- Must be the identifier for an
* existing read replica DB instance
- Must contain from 1 to 63
* alphanumeric characters or hyphens
- First character must be a
* letter
- Cannot end with a hyphen or contain two consecutive
* hyphens
Example: mydbinstance
*
* @param dBInstanceIdentifier The DB instance identifier. This value is stored as a lowercase
* string.
Constraints:
- Must be the identifier for an
* existing read replica DB instance
- Must contain from 1 to 63
* alphanumeric characters or hyphens
- First character must be a
* letter
- Cannot end with a hyphen or contain two consecutive
* hyphens
Example: mydbinstance
*/
public void setDBInstanceIdentifier(String dBInstanceIdentifier) {
this.dBInstanceIdentifier = dBInstanceIdentifier;
}
/**
* The DB instance identifier. This value is stored as a lowercase
* string.
Constraints:
- Must be the identifier for an
* existing read replica DB instance
- Must contain from 1 to 63
* alphanumeric characters or hyphens
- First character must be a
* letter
- Cannot end with a hyphen or contain two consecutive
* hyphens
Example: mydbinstance
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param dBInstanceIdentifier The DB instance identifier. This value is stored as a lowercase
* string.
Constraints:
- Must be the identifier for an
* existing read replica DB instance
- Must contain from 1 to 63
* alphanumeric characters or hyphens
- First character must be a
* letter
- Cannot end with a hyphen or contain two consecutive
* hyphens
Example: mydbinstance
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PromoteReadReplicaRequest withDBInstanceIdentifier(String dBInstanceIdentifier) {
this.dBInstanceIdentifier = dBInstanceIdentifier;
return this;
}
/**
* The number of days to retain automated backups. Setting this parameter
* to a positive number enables backups. Setting this parameter to 0
* disables automated backups.
Default: 1
Constraints:
* - Must be a value from 0 to 8
*
* @return The number of days to retain automated backups. Setting this parameter
* to a positive number enables backups. Setting this parameter to 0
* disables automated backups. Default: 1
Constraints:
* - Must be a value from 0 to 8
*/
public Integer getBackupRetentionPeriod() {
return backupRetentionPeriod;
}
/**
* The number of days to retain automated backups. Setting this parameter
* to a positive number enables backups. Setting this parameter to 0
* disables automated backups. Default: 1
Constraints:
* - Must be a value from 0 to 8
*
* @param backupRetentionPeriod The number of days to retain automated backups. Setting this parameter
* to a positive number enables backups. Setting this parameter to 0
* disables automated backups. Default: 1
Constraints:
* - Must be a value from 0 to 8
*/
public void setBackupRetentionPeriod(Integer backupRetentionPeriod) {
this.backupRetentionPeriod = backupRetentionPeriod;
}
/**
* The number of days to retain automated backups. Setting this parameter
* to a positive number enables backups. Setting this parameter to 0
* disables automated backups. Default: 1
Constraints:
* - Must be a value from 0 to 8
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param backupRetentionPeriod The number of days to retain automated backups. Setting this parameter
* to a positive number enables backups. Setting this parameter to 0
* disables automated backups.
Default: 1
Constraints:
* - Must be a value from 0 to 8
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PromoteReadReplicaRequest withBackupRetentionPeriod(Integer backupRetentionPeriod) {
this.backupRetentionPeriod = backupRetentionPeriod;
return this;
}
/**
* The daily time range during which automated backups are created if
* automated backups are enabled, using the
* BackupRetentionPeriod parameter. Default: A 30-minute
* window selected at random from an 8-hour block of time per region. See
* the Amazon RDS User Guide for the time blocks for each region from
* which the default backup windows are assigned.
Constraints: Must
* be in the format hh24:mi-hh24:mi. Times should be
* Universal Time Coordinated (UTC). Must not conflict with the preferred
* maintenance window. Must be at least 30 minutes.
*
* @return The daily time range during which automated backups are created if
* automated backups are enabled, using the
* BackupRetentionPeriod parameter.
Default: A 30-minute
* window selected at random from an 8-hour block of time per region. See
* the Amazon RDS User Guide for the time blocks for each region from
* which the default backup windows are assigned.
Constraints: Must
* be in the format hh24:mi-hh24:mi. Times should be
* Universal Time Coordinated (UTC). Must not conflict with the preferred
* maintenance window. Must be at least 30 minutes.
*/
public String getPreferredBackupWindow() {
return preferredBackupWindow;
}
/**
* The daily time range during which automated backups are created if
* automated backups are enabled, using the
* BackupRetentionPeriod parameter.
Default: A 30-minute
* window selected at random from an 8-hour block of time per region. See
* the Amazon RDS User Guide for the time blocks for each region from
* which the default backup windows are assigned.
Constraints: Must
* be in the format hh24:mi-hh24:mi. Times should be
* Universal Time Coordinated (UTC). Must not conflict with the preferred
* maintenance window. Must be at least 30 minutes.
*
* @param preferredBackupWindow The daily time range during which automated backups are created if
* automated backups are enabled, using the
* BackupRetentionPeriod parameter.
Default: A 30-minute
* window selected at random from an 8-hour block of time per region. See
* the Amazon RDS User Guide for the time blocks for each region from
* which the default backup windows are assigned.
Constraints: Must
* be in the format hh24:mi-hh24:mi. Times should be
* Universal Time Coordinated (UTC). Must not conflict with the preferred
* maintenance window. Must be at least 30 minutes.
*/
public void setPreferredBackupWindow(String preferredBackupWindow) {
this.preferredBackupWindow = preferredBackupWindow;
}
/**
* The daily time range during which automated backups are created if
* automated backups are enabled, using the
* BackupRetentionPeriod parameter.
Default: A 30-minute
* window selected at random from an 8-hour block of time per region. See
* the Amazon RDS User Guide for the time blocks for each region from
* which the default backup windows are assigned.
Constraints: Must
* be in the format hh24:mi-hh24:mi. Times should be
* Universal Time Coordinated (UTC). Must not conflict with the preferred
* maintenance window. Must be at least 30 minutes.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param preferredBackupWindow The daily time range during which automated backups are created if
* automated backups are enabled, using the
* BackupRetentionPeriod parameter.
Default: A 30-minute
* window selected at random from an 8-hour block of time per region. See
* the Amazon RDS User Guide for the time blocks for each region from
* which the default backup windows are assigned.
Constraints: Must
* be in the format hh24:mi-hh24:mi. Times should be
* Universal Time Coordinated (UTC). Must not conflict with the preferred
* maintenance window. Must be at least 30 minutes.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PromoteReadReplicaRequest withPreferredBackupWindow(String preferredBackupWindow) {
this.preferredBackupWindow = preferredBackupWindow;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDBInstanceIdentifier() != null) sb.append("DBInstanceIdentifier: " + getDBInstanceIdentifier() + ",");
if (getBackupRetentionPeriod() != null) sb.append("BackupRetentionPeriod: " + getBackupRetentionPeriod() + ",");
if (getPreferredBackupWindow() != null) sb.append("PreferredBackupWindow: " + getPreferredBackupWindow() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDBInstanceIdentifier() == null) ? 0 : getDBInstanceIdentifier().hashCode());
hashCode = prime * hashCode + ((getBackupRetentionPeriod() == null) ? 0 : getBackupRetentionPeriod().hashCode());
hashCode = prime * hashCode + ((getPreferredBackupWindow() == null) ? 0 : getPreferredBackupWindow().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof PromoteReadReplicaRequest == false) return false;
PromoteReadReplicaRequest other = (PromoteReadReplicaRequest)obj;
if (other.getDBInstanceIdentifier() == null ^ this.getDBInstanceIdentifier() == null) return false;
if (other.getDBInstanceIdentifier() != null && other.getDBInstanceIdentifier().equals(this.getDBInstanceIdentifier()) == false) return false;
if (other.getBackupRetentionPeriod() == null ^ this.getBackupRetentionPeriod() == null) return false;
if (other.getBackupRetentionPeriod() != null && other.getBackupRetentionPeriod().equals(this.getBackupRetentionPeriod()) == false) return false;
if (other.getPreferredBackupWindow() == null ^ this.getPreferredBackupWindow() == null) return false;
if (other.getPreferredBackupWindow() != null && other.getPreferredBackupWindow().equals(this.getPreferredBackupWindow()) == false) return false;
return true;
}
}