/* * 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.rds.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DeleteDBInstanceRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** ** The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive. *
** Constraints: *
** Must match the name of an existing DB instance. *
** A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. If you * enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB * snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created. *
*
* If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier
parameter.
*
* When a DB instance is in a failure state and has a status of failed
,
* incompatible-restore
, or incompatible-network
, RDS can delete the instance only if you
* enable this parameter.
*
* If you delete a read replica or an RDS Custom instance, you must enable this setting. *
** This setting is required for RDS Custom. *
*/ private Boolean skipFinalSnapshot; /** *
* The DBSnapshotIdentifier
of the new DBSnapshot
created when the
* SkipFinalSnapshot
parameter is disabled.
*
* If you enable this parameter and also enable SkipFinalShapshot, the command results in an error. *
** This setting doesn't apply to RDS Custom. *
** Constraints: *
** Must be 1 to 255 letters or numbers. *
** First character must be a letter. *
** Can't end with a hyphen or contain two consecutive hyphens. *
** Can't be specified when deleting a read replica. *
** A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This * parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is * deleted. *
*/ private Boolean deleteAutomatedBackups; /** * Default constructor for DeleteDBInstanceRequest object. Callers should use the setter or fluent setter (with...) * methods to initialize the object after creating it. */ public DeleteDBInstanceRequest() { } /** * Constructs a new DeleteDBInstanceRequest object. Callers should use the setter or fluent setter (with...) methods * to initialize any additional object members. * * @param dBInstanceIdentifier * The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive. ** Constraints: *
** Must match the name of an existing DB instance. *
** The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive. *
** Constraints: *
** Must match the name of an existing DB instance. *
** Constraints: *
** Must match the name of an existing DB instance. *
** The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive. *
** Constraints: *
** Must match the name of an existing DB instance. *
** Constraints: *
** Must match the name of an existing DB instance. *
** The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive. *
** Constraints: *
** Must match the name of an existing DB instance. *
** Constraints: *
** Must match the name of an existing DB instance. *
** A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. If you * enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB * snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created. *
*
* If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier
parameter.
*
* When a DB instance is in a failure state and has a status of failed
,
* incompatible-restore
, or incompatible-network
, RDS can delete the instance only if you
* enable this parameter.
*
* If you delete a read replica or an RDS Custom instance, you must enable this setting. *
** This setting is required for RDS Custom. *
* * @param skipFinalSnapshot * A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. * If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS * creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB * snapshot is created.
* If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier
parameter.
*
* When a DB instance is in a failure state and has a status of failed
,
* incompatible-restore
, or incompatible-network
, RDS can delete the instance only
* if you enable this parameter.
*
* If you delete a read replica or an RDS Custom instance, you must enable this setting. *
** This setting is required for RDS Custom. */ public void setSkipFinalSnapshot(Boolean skipFinalSnapshot) { this.skipFinalSnapshot = skipFinalSnapshot; } /** *
* A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. If you * enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB * snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created. *
*
* If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier
parameter.
*
* When a DB instance is in a failure state and has a status of failed
,
* incompatible-restore
, or incompatible-network
, RDS can delete the instance only if you
* enable this parameter.
*
* If you delete a read replica or an RDS Custom instance, you must enable this setting. *
** This setting is required for RDS Custom. *
* * @return A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. * If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS * creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB * snapshot is created.
* If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier
* parameter.
*
* When a DB instance is in a failure state and has a status of failed
,
* incompatible-restore
, or incompatible-network
, RDS can delete the instance only
* if you enable this parameter.
*
* If you delete a read replica or an RDS Custom instance, you must enable this setting. *
** This setting is required for RDS Custom. */ public Boolean getSkipFinalSnapshot() { return this.skipFinalSnapshot; } /** *
* A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. If you * enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB * snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created. *
*
* If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier
parameter.
*
* When a DB instance is in a failure state and has a status of failed
,
* incompatible-restore
, or incompatible-network
, RDS can delete the instance only if you
* enable this parameter.
*
* If you delete a read replica or an RDS Custom instance, you must enable this setting. *
** This setting is required for RDS Custom. *
* * @param skipFinalSnapshot * A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. * If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS * creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB * snapshot is created.
* If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier
parameter.
*
* When a DB instance is in a failure state and has a status of failed
,
* incompatible-restore
, or incompatible-network
, RDS can delete the instance only
* if you enable this parameter.
*
* If you delete a read replica or an RDS Custom instance, you must enable this setting. *
** This setting is required for RDS Custom. * @return Returns a reference to this object so that method calls can be chained together. */ public DeleteDBInstanceRequest withSkipFinalSnapshot(Boolean skipFinalSnapshot) { setSkipFinalSnapshot(skipFinalSnapshot); return this; } /** *
* A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. If you * enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB * snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created. *
*
* If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier
parameter.
*
* When a DB instance is in a failure state and has a status of failed
,
* incompatible-restore
, or incompatible-network
, RDS can delete the instance only if you
* enable this parameter.
*
* If you delete a read replica or an RDS Custom instance, you must enable this setting. *
** This setting is required for RDS Custom. *
* * @return A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. * If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS * creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB * snapshot is created.
* If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier
* parameter.
*
* When a DB instance is in a failure state and has a status of failed
,
* incompatible-restore
, or incompatible-network
, RDS can delete the instance only
* if you enable this parameter.
*
* If you delete a read replica or an RDS Custom instance, you must enable this setting. *
** This setting is required for RDS Custom. */ public Boolean isSkipFinalSnapshot() { return this.skipFinalSnapshot; } /** *
* The DBSnapshotIdentifier
of the new DBSnapshot
created when the
* SkipFinalSnapshot
parameter is disabled.
*
* If you enable this parameter and also enable SkipFinalShapshot, the command results in an error. *
** This setting doesn't apply to RDS Custom. *
** Constraints: *
** Must be 1 to 255 letters or numbers. *
** First character must be a letter. *
** Can't end with a hyphen or contain two consecutive hyphens. *
** Can't be specified when deleting a read replica. *
*DBSnapshotIdentifier
of the new DBSnapshot
created when the
* SkipFinalSnapshot
parameter is disabled. * If you enable this parameter and also enable SkipFinalShapshot, the command results in an error. *
** This setting doesn't apply to RDS Custom. *
** Constraints: *
** Must be 1 to 255 letters or numbers. *
** First character must be a letter. *
** Can't end with a hyphen or contain two consecutive hyphens. *
** Can't be specified when deleting a read replica. *
*
* The DBSnapshotIdentifier
of the new DBSnapshot
created when the
* SkipFinalSnapshot
parameter is disabled.
*
* If you enable this parameter and also enable SkipFinalShapshot, the command results in an error. *
** This setting doesn't apply to RDS Custom. *
** Constraints: *
** Must be 1 to 255 letters or numbers. *
** First character must be a letter. *
** Can't end with a hyphen or contain two consecutive hyphens. *
** Can't be specified when deleting a read replica. *
*DBSnapshotIdentifier
of the new DBSnapshot
created when the
* SkipFinalSnapshot
parameter is disabled. * If you enable this parameter and also enable SkipFinalShapshot, the command results in an error. *
** This setting doesn't apply to RDS Custom. *
** Constraints: *
** Must be 1 to 255 letters or numbers. *
** First character must be a letter. *
** Can't end with a hyphen or contain two consecutive hyphens. *
** Can't be specified when deleting a read replica. *
*
* The DBSnapshotIdentifier
of the new DBSnapshot
created when the
* SkipFinalSnapshot
parameter is disabled.
*
* If you enable this parameter and also enable SkipFinalShapshot, the command results in an error. *
** This setting doesn't apply to RDS Custom. *
** Constraints: *
** Must be 1 to 255 letters or numbers. *
** First character must be a letter. *
** Can't end with a hyphen or contain two consecutive hyphens. *
** Can't be specified when deleting a read replica. *
*DBSnapshotIdentifier
of the new DBSnapshot
created when the
* SkipFinalSnapshot
parameter is disabled. * If you enable this parameter and also enable SkipFinalShapshot, the command results in an error. *
** This setting doesn't apply to RDS Custom. *
** Constraints: *
** Must be 1 to 255 letters or numbers. *
** First character must be a letter. *
** Can't end with a hyphen or contain two consecutive hyphens. *
** Can't be specified when deleting a read replica. *
** A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This * parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is * deleted. *
* * @param deleteAutomatedBackups * A value that indicates whether to remove automated backups immediately after the DB instance is deleted. * This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB * instance is deleted. */ public void setDeleteAutomatedBackups(Boolean deleteAutomatedBackups) { this.deleteAutomatedBackups = deleteAutomatedBackups; } /** ** A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This * parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is * deleted. *
* * @return A value that indicates whether to remove automated backups immediately after the DB instance is deleted. * This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB * instance is deleted. */ public Boolean getDeleteAutomatedBackups() { return this.deleteAutomatedBackups; } /** ** A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This * parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is * deleted. *
* * @param deleteAutomatedBackups * A value that indicates whether to remove automated backups immediately after the DB instance is deleted. * This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB * instance is deleted. * @return Returns a reference to this object so that method calls can be chained together. */ public DeleteDBInstanceRequest withDeleteAutomatedBackups(Boolean deleteAutomatedBackups) { setDeleteAutomatedBackups(deleteAutomatedBackups); return this; } /** ** A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This * parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is * deleted. *
* * @return A value that indicates whether to remove automated backups immediately after the DB instance is deleted. * This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB * instance is deleted. */ public Boolean isDeleteAutomatedBackups() { return this.deleteAutomatedBackups; } /** * 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 (getDBInstanceIdentifier() != null) sb.append("DBInstanceIdentifier: ").append(getDBInstanceIdentifier()).append(","); if (getSkipFinalSnapshot() != null) sb.append("SkipFinalSnapshot: ").append(getSkipFinalSnapshot()).append(","); if (getFinalDBSnapshotIdentifier() != null) sb.append("FinalDBSnapshotIdentifier: ").append(getFinalDBSnapshotIdentifier()).append(","); if (getDeleteAutomatedBackups() != null) sb.append("DeleteAutomatedBackups: ").append(getDeleteAutomatedBackups()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DeleteDBInstanceRequest == false) return false; DeleteDBInstanceRequest other = (DeleteDBInstanceRequest) obj; if (other.getDBInstanceIdentifier() == null ^ this.getDBInstanceIdentifier() == null) return false; if (other.getDBInstanceIdentifier() != null && other.getDBInstanceIdentifier().equals(this.getDBInstanceIdentifier()) == false) return false; if (other.getSkipFinalSnapshot() == null ^ this.getSkipFinalSnapshot() == null) return false; if (other.getSkipFinalSnapshot() != null && other.getSkipFinalSnapshot().equals(this.getSkipFinalSnapshot()) == false) return false; if (other.getFinalDBSnapshotIdentifier() == null ^ this.getFinalDBSnapshotIdentifier() == null) return false; if (other.getFinalDBSnapshotIdentifier() != null && other.getFinalDBSnapshotIdentifier().equals(this.getFinalDBSnapshotIdentifier()) == false) return false; if (other.getDeleteAutomatedBackups() == null ^ this.getDeleteAutomatedBackups() == null) return false; if (other.getDeleteAutomatedBackups() != null && other.getDeleteAutomatedBackups().equals(this.getDeleteAutomatedBackups()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getDBInstanceIdentifier() == null) ? 0 : getDBInstanceIdentifier().hashCode()); hashCode = prime * hashCode + ((getSkipFinalSnapshot() == null) ? 0 : getSkipFinalSnapshot().hashCode()); hashCode = prime * hashCode + ((getFinalDBSnapshotIdentifier() == null) ? 0 : getFinalDBSnapshotIdentifier().hashCode()); hashCode = prime * hashCode + ((getDeleteAutomatedBackups() == null) ? 0 : getDeleteAutomatedBackups().hashCode()); return hashCode; } @Override public DeleteDBInstanceRequest clone() { return (DeleteDBInstanceRequest) super.clone(); } }